Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
m-tmatma opened this issue Apr 29, 2020 · 6 comments
Open

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

m-tmatma opened this issue Apr 29, 2020 · 6 comments

Comments

@m-tmatma
Copy link
Member

m-tmatma commented Apr 29, 2020

sakura-editor/sakura-editor.github.io#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/checkouthttps://githhub.com/sakura-editor/sakura を GitHub Actions で checkout する
  2. 上記リポジトリで Doxygen Action を使用して doxygen のドキュメントを生成する
  3. Deploy to GitHub Pages を使用して gh-pages のブランチに push する (※ GitHub Pages actionDeploy to GitHub Pages) に変更
@m-tmatma
Copy link
Member Author

m-tmatma commented Apr 29, 2020

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

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

@m-tmatma
Copy link
Member Author

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

@m-tmatma
Copy link
Member Author

m-tmatma commented Apr 29, 2020

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

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

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

@m-tmatma
Copy link
Member Author

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

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

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

@m-tmatma
Copy link
Member Author

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

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

@m-tmatma
Copy link
Member Author

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

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant