2022年9月1日現在、このブログはmarkdownファイルからHugoを使って静的サイトを生成し、GitHub Pagesで公開しています。元々GitHub Pagesにページをデプロイするには、生成済みページを入れた専用のブランチ(一般にgh-pages
)を用意するか、生成済みページを入れたディレクトリを用意するか、という二択で、いずれにせよページを生成してから生成されたページをGitHubにpushする必要がありました。前者の場合gh-pages
ブランチはmain
ないしmaster
ブランチとは一切関係の無いコミット履歴となり、ぱっと見よく分からないですし、後者の場合gitのcommit logにサイト生成のコミットが入ってしまいきれいではありませんし、CIでbuild/pushをしている場合ローカルに毎回pullする必要も発生します。当サイトでもgh-pages
ブランチに生成済みページをpushする運用となっていました。
ところが最近、GitHub Actionsから直接GitHub Pagesにページをデプロイできる様になった というではないですか。これは試してみるしかない、ということで設定を変更してみました。
まず、リポジトリのSettings > Pagesから、SourceをGitHub Actionsに変更します。
次に、GitHub Actionsのworkflow設定をactions/starter-workflows
を参考に書き換えます。重要なのは2点で、actions/upload-pages-artifact
を使って生成済みページをartifactとしてアップロードする点と、actions/deploy-pages
を使ってGitHub Pagesにデプロイをすることです。
steps:
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./public
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
多分artifactのアップロードとページのデプロイは同じJob内で実施しても問題無く動くとは思いますが、actions/deploy-pagesのREADME によると専用のJobに分けることが推奨されているようです。
ということで、簡単に設定ができて、このページもシュッとActionsから直接Pagesにデプロイされている・・・はず。