doxygen の生成結果を GitHub Pages で公開する

[m-tmatma]

https://github.com/sakura-editor/sakura-editor.github.io/issues/6 の件ですが、GitHub Actions で doxygen の生成を行って、 GitHub Pages に push して公開しようと考えています。

準備

1. https://githhub.com/sakura-editor/doxygen を作る
2. https://githhub.com/sakura-editor/doxygen の設定で gh-pages のブランチを公開するように設定する

処理フロー

.github/workflows/main.yml を作成して、以下の処理を GitHub Actions で実行する

1. actions/checkout で https://githhub.com/sakura-editor/sakura を GitHub Actions で checkout する
2. 上記リポジトリで Doxygen Action を使用して doxygen のドキュメントを生成する
3. Deploy to GitHub Pages を使用して gh-pages のブランチに push する (※ GitHub Pages action → Deploy to GitHub Pages) に変更

[m-tmatma]

https://github.com/test-sakura-editor/doxygen/blob/master/.github/workflows/main.yml のように記載して

https://test-sakura-editor.github.io/doxygen/master/ のように公開できるのは実験で確認済みです。

[m-tmatma]

https://github.com/sakura-editor/sakura-editor.github.io/issues/25 に関しても同様の方法で自動化可能だと思います。

[m-tmatma]

master とリリース版とか複数公開できないか検討中

参考サイト https://github.com/peaceiris/actions-gh-pages/issues/79

↑ Deploy to GitHub Pages では実現できているので GitHub Pages action でも対応してほしいという要望が却下されている。→ 単に Deploy to GitHub Pages に乗り換える。

[m-tmatma]

master とリリース版とか複数公開できないか検討中

参考サイト peaceiris/actions-gh-pages#79

GitHub Pages action ではなく Deploy to GitHub Pages を使うようにすることで subdirectory に push できた

[m-tmatma]

2. 上記リポジトリで Doxygen Action を使用して doxygen のドキュメントを生成する

sakura-editor/sakura で生成して、doxygen のリポジトリに push したほうがいいかも そうすれば tag に対してと master に対して生成して複数のバージョンをディレクトリごとに分けて公開することができる。

[m-tmatma]

2. 上記リポジトリで Doxygen Action を使用して doxygen のドキュメントを生成する

sakura-editor/sakura で生成して、doxygen のリポジトリに push したほうがいいかも そうすれば tag に対してと master に対して生成して複数のバージョンをディレクトリごとに分けて公開することができる。

sakura → doxygen リポジトリだと認証エラーになるみたい。