GitHub ActionsでGitHub Wikiを更新する

GitHub Wiki はGitリポジトリで管理されているので、公式ドキュメントに記載のある通り、ローカル環境の変更をPushすることでも更新できます。

なので、GitHub ActionsでWikiを更新することもできます。以下にワークフローの例を示します。

name: Testing update wiki

on: push

jobs:
  update-wiki:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          repository: 'user/repo.wiki'      # wiki リポジトリをcloneする
                                            # user をユーザー名やOrganization名に、repo の部分をリポジトリ名に変更すること

      - run: |                              # test.md をPushしてWikiを更新する
          git config --global user.email "bot@example.com"
          git config --global user.name "test-bot"
          echo '# test' >> test.md
          git add test.md
          git commit -m 'test commit'
          git push origin master

ドキュメントを自動更新したり、レポートを自動生成するのに便利そうです。ではでは。