Takym > WikiToPages

GitHub Wiki を GitHub Pages に変換する仕組み

現行の仕組み

1. GitHub Wiki を更新する。
2. 一ヶ月おきに Dependabot が更新を確認し、更新があればプルリクエストを作成する。
3. プルリクエストを手動でマージする。
4. GitHub Pages が Markdown を HTML へ変換してウェブサイトとして公開する。
   • GitHub Pages は Jekyll を利用している。

現在、提案中の仕組み

1. 次の条件の何れかが満たされた時に GitHub Actions のワークフロー「Update Wiki Submodule」が作動する：
   • master ブランチが更新された時
   • master ブランチに対してプルリクエストが開かれた時
   • 日本時間における毎日午前三時
   • 手動で呼び出された時
2. 最新の master ブランチの wiki ディレクトリに移動し、ウィキの最新の状態へ同期する。
3. コミットを作成し、プッシュする。
4. GitHub Pages が Markdown を HTML へ変換してウェブサイトとして公開する。
   • GitHub Pages は Jekyll を利用している。

その他

• 上手く動作しなかった時の保険として Dependabot の設定は残してある。
• ステータスバッジの表示例：
  • 
  • （フォーク）

廃案

1. GitHub Wiki を更新する。
2. 一日おきに Dependabot が更新を確認し、更新があればプルリクエストを作成する。
3. GitHub Actions のワークフロー「Merge Dependabot PR」が作動する。
4. プルリクエストが自動的にマージされる。
5. GitHub Actions が Markdown を HTML へ変換してウェブサイトとして公開する。
   • GitHub Actions は Jekyll を利用している。

その他

• GitHub Wiki をサブモジュールとして wiki ディレクトリへ埋め込んでいる。
• Dependabot はサブモジュールの更新を検知する事ができる。
• Dependabot が作成し、且つ dependencies と submodules の二つのラベルを持つプルリクエストのみをマージする様にしている。
• リポジトリに対して権限があれば、https://github.com/osdev-jp/osdev-jp.github.io/network/updates から強制的に Dependabot を実行できる。

関連 PR

• https://github.com/osdev-jp/osdev-jp.github.io/pull/6
• https://github.com/osdev-jp/osdev-jp.github.io/pull/23