GitHub Actionsを利用したMkDocsの自動デプロイ

MkDocsでWebページを編集する際、下記の図のようなワークフローを採っています。

今回は、GitHub Actionsを利用して、MkDocsでのGitHub Pagesへのページ公開を自動化しました。

Github Actionsを利用するには

2020年2月時点で、GitHubのユーザであれば、Github Actionsを利用でき、 Freeプランでは、2,000分/月の実行時間内であれば無料で利用できます。

詳細については、Github Actionsのページ¹やヘルプ²を参照するとよいでしょう。

Github Actionsを利用するには、対象のリポジトリのいずれかのブランチに .github/workflow/[適当なファイル名].yml を作成して、その中にワークフローをYaml形式で定義します。

Github Actionsのヘルプ¹内にリファレンスがあるので、そちらを参照して作成しましょう。

ワークフロー作成

今回は下記のような定義を作成しました。

Github Actionsでは、実行環境をWindows/MacOS/Ubuntuから選択できますが、
今回はWindows上のVSCodeで編集/MkDocsを実行しているので、デプロイ時の環境もWindowsを選択しました。
ワークフロー内の各ステップについては、Yamlファイル内のコメントで説明しています。