Backlog の課題に GitHub のプルリクを連携する GitHub Action を作りました
はじめに
プルリクストをBacklog課題のコメントに追加するGitHub Actionを公開しました。ぜひご利用ください。
GitHub Action
GitHub Actionとは、GitHub内で完結するCI / CDツールです。個人開発や仕事で大変お世話になっています。
Actions | GitHub
https://github.co.jp/features/actions
そのうち、仕事で活用できたパッケージを1つ公開し、GitHub Marketplaceに公開しています。
Backlog Notify
プッシュされたりプルリクストが作成されたらBacklog課題のコメントにリンクコメントを送信するGitHub Actionです。キーワードによる課題の状態変更も可能です。
Backlog Notify · Actions · GitHub Marketplace
https://github.com/marketplace/actions/backlog-notify
使用方法
プルリクエスト
![Backlog Notifyの動作をイメージした図。GitHub にプルリクエストを作成すると Backlog にプルリクエスト情報のコメントがされる](/static/fb596115c75fecf09cc9a080891e3182/0a47e/image01.png)
プルリクエストのタイトルの中に課題番号 (例: PROJECT-123 ) がある場合は、その課題にプルリクエストに関するコメントを送信します。課題キーは先頭にある1つのみ認識します。
PROJECT-123 不具合修正
また、キーワードがある場合は、マージされたタイミングで課題ステータスを変更します。キーワードは末尾にある1つのみ認識します。
- #fix #fixes #fixed のどれかで処理済み
- #close #closes #closed のどれかで完了
PROJECT-123 不具合修正 #fix
プッシュ
![Backlog Notifyの動作をイメージした図。GitHub にプッシュすると Backlog にコミット情報のコメントがされる](/static/58bcfbf8309cf537b158f15dd8cd6017/0a47e/image02.png)
コミットメッセージの中に課題番号 (例: PROJECT-123 ) がある場合は、その課題にコミットログに関するコメントを送信します。課題キーは先頭にある1つのみ認識します。
PROJECT-123 不具合修正
また、キーワードがある場合は、プッシュされたタイミングで課題ステータスを変更します。キーワードは末尾にある1つのみ認識します。
- #fix #fixes #fixed のどれかで処理済み
- #close #closes #closed のどれかで完了
ちなみに空コミットすることで、Backlogを開かずともコメントを残したりステータスを変更できます。
PROJECT-123 不具合修正 #fix