PR ビルドの環境を作る #780

Activity

1. cocoatomo commented on Feb 21, 2018

   

   cocoatomo

   on Feb 21, 2018

   Last edited by cocoatomo

   ContributorAuthor

   More actions

   構成案は以下の通り。

   1. python-docs-ja への PR をトリガーとして、CI サービスで PR ビルドを走らせ、決まった場所にビルドしたドキュメントを公開する。
   2. そのドキュメントを見て確認ができたら、何らかの方法で承認/却下の判断を記録、次の処理へ伝える。
   3. 却下の場合は PR にその旨を表示し処理は終了。PR の改善を行い更新することで「1」の手順を起動する。
   4. 承認の場合は PR にその旨を表示し、PR のマージを行い、変更のあった .po ファイルを Transifex へアップロードする。
   5. 数日待つとドキュメントが docs.python.org に公開される。
2. cocoatomo

   added

   TODO

   on Feb 21, 2018
3. cocoatomo commented on Mar 17, 2020

   

   cocoatomo

   on Mar 17, 2020

   ContributorAuthor

   More actions

   主に課題となるのは、レポジトリの認証まわりになる。

   1. PRビルドで作成したドキュメントファイルをどうやってpushするか?
      • 対応策: 秘密鍵をsecretファイルに追加しておく
   2. PRおよびPR更新後の承認/却下はどう行う?
      • 対応策: 承認/却下は普段のPRと同じように行う。
      • 対応策: push, PR, PR-Mergeの3パターンで別々の処理を動かす
   3. Transifexへのアップロードはどうする?
      • 対応策: 秘密鍵があるのでtxコマンドでアップロード
      • 対応策: git diffで変更があったファイルだけをアップロード
4. cocoatomo

   self-assigned this

   on Mar 28, 2020
5. cocoatomo commented on May 24, 2020

   

   cocoatomo

   on May 24, 2020

   ContributorAuthor

   More actions

   PRビルドをTravis CIという外部のCI/CDサービスで行ったとき、設定してあったsecretが使えない（恐らくsecretが漏れるのを防ぐため）問題に引っ掛かっており、なかなかいい構成方法が思い浮かばなかった。

   GitHub Actionが出てきてくれたおかげで一時的なGH_TOKENが扱えるようになり、ビルド後にドキュメントをpython/python-docs-jaのgh-pagesにpushできるようになった。

   現在、実装が済んでいるのは、次の機能。

   1. PRが出されたときに、そのPRをマージしたソースコードでドキュメントをビルドし、GitHub Pagesに公開する。さらに、PRページドキュメントが公開されている場所のURLをコメントする。
   2. PRを閉じたときに、ビルドしたドキュメントを削除する。

   次の機能が実装が済んでいない。

   3. PRがマージされたときに、ビルドしたドキュメントを削除する。