概要
特定のユーザーの PR/Issue 情報をレポジトリごとに、定期的に集計してサマリーを自動で作成する機能を gihub actions を用いて作成しました。
経緯
私のチームでは以下のような課題がありました。
開発環境を構築したエンジニアがチーム内におらず、チームメンバーだけではどういった保守運用が必要かわからない状態でした。幸い、環境構築をしてくれたエンジニアは別のレポジトリで、同じ開発環境で開発を行っていた。そこのレポジトリを定期的にウォッチし、参考にさせてもらうことで、自チームの補修運用に役立てることにしました。
とはいえ、ウォッチしなければいけないレポジトリが複数あったり、毎回レポジトリを検索するのが大変です。なので、Github の Slack インテグレーションを検討しましたが、特定のユーザーの PR/Issue をレポジトリごとにウォッチする機能はありませんでした。うーん、かゆいところに手が届かない、、、。
ないなら作ってしまえ！
作ったもの
特定のユーザーの PR/Issue 情報をレポジトリごとに集計してサマリーを作成する機能を作りました。
- config file で設定を管理
- ユーザー、レポジトリ、いつからの PR/Issue を取得するかなど
- 複数設定可能
- github acitons の
GITHUB_STEP_SUMMARYを使って、サマリーを自動で定期的に作成 - ローカルでサマリーをマークダウン形式で作成
利用方法は README.md に記載しています。興味のあるかがいらしたら、そちらを参照してください。
例）https://github.com/mmikami-lifull/github-author-report/actions/runs/5473225350d
| Author | Title | URL | CreatedAt |
|---|---|---|---|
| mmikami-lifull | test2 | https://github.com/mmikami-lifull/github-author-report/issues/2 | 2023-07-06T07:55:58Z |
| mmikami-lifull | test1 | https://github.com/mmikami-lifull/github-author-report/issues/1 | 2023-07-06T07:55:49Z |
| mmikami-lifull | feat(workflows): add author issue report workflow | https://github.com/mmikami-lifull/github-author-report/pull/3 | 2023-07-06T07:58:43Z |