最近 Pandoc 以外の選択肢として Re:VIEW を試している.ビルドを自動化するために GitHub Actions で Re:VIEW プロジェクトをビルドできるように設定してみた.今回は vvakame/review
Docker Image を使うことにした.検証日時点で最新となる Re:VIEW v5.1 もサポートされていて良かった💡その前に GitHub Marketplace で Re:VIEW 専用の Action も探してみたけど,あまり良さそうなものはなかった.
Re:VIEW プロジェクトを作る
サンプルとして review-init
コマンドを使って Re:VIEW プロジェクトを作る.今回は sandbox-github-actions-review
という名前にした.以下のように rake pdf
コマンドで簡単に PDF 化できる.
$ review-init sandbox-github-actions-review --without-doc --without-config-comment $ cd sandbox-github-actions-review $ rake pdf
GitHub Actions
さっそく GitHub Actions ワークフロー用に YAML を書く.今回は「main
ブランチに対するプルリクエスト」と「main
ブランチに対するプッシュ(マージなど)」をトリガーするように on
を設定した.そして jobs
に vvakame/review
Docker Image を使うように設定した.なお actions/upload-artifact
を使うとビルド結果などのアーティファクトを簡単にファイルをアップロードできる.便利!
name: Build on: push: branches: - main pull_request: branches: - main jobs: build: name: Re:VIEW Workflow runs-on: ubuntu-latest container: docker://vvakame/review:5.1 steps: - uses: actions/checkout@v2 - name: Build PDF run: rake pdf - uses: actions/upload-artifact@v2 with: name: Artifacts path: book.pdf
YAML 構文はドキュメントに載っている.
https://docs.github.com/ja/actions/using-workflows/workflow-syntax-for-github-actionsdocs.github.com
ビルド結果
GitHub Actions でうまくビルドできた👌
関連記事
もし GitHub Actions 入門するなら以下の記事で紹介している「GitHub Learning Lab」を使うと便利!
Re:VIEW で「節単位」に分割したファイルをビルドする Tips は以下にまとめてある!