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
使用方法
プルリクエスト
プルリクエストのタイトルの中に課題番号 (例: PROJECT-123 ) がある場合は、その課題にプルリクエストに関するコメントを送信します。課題キーは先頭にある 1 つのみ認識します。
PROJECT-123 不具合修正
また、キーワードがある場合は、マージされたタイミングで課題ステータスを変更します。キーワードは末尾にある 1 つのみ認識します。
- #fix #fixes #fixed のどれかで処理済み
- #close #closes #closed のどれかで完了
PROJECT-123 不具合修正 #fix
プッシュ
コミットメッセージの中に課題番号 (例: PROJECT-123 ) がある場合は、その課題にコミットログに関するコメントを送信します。課題キーは先頭にある 1 つのみ認識します。
PROJECT-123 不具合修正
また、キーワードがある場合は、プッシュされたタイミングで課題ステータスを変更します。キーワードは末尾にある 1 つのみ認識します。
- #fix #fixes #fixed のどれかで処理済み
- #close #closes #closed のどれかで完了
ちなみに空コミットすることで、Backlog を開かずともコメントを残したりステータスを変更することができます。
PROJECT-123 不具合修正 #fix
設定方法
BOT ユーザーの作成
- Backlog のプロジェクトに移動します。
- プロジェクト設定 → 参加ユーザー → 新しいユーザの追加はこちらから を選択します。
- クラシックプランの場合は 一般ユーザ 、新プランの場合は ゲスト を選択します。
- 登録します。
Backlog API キーの取得
- 登録した BOT アカウントにログインします。
- 個人設定 → API → 登録 で API キーを発行します。
API キーを GitHub に登録
- GitHub のリポジトリページに移動します。
- Setting → Secrets → Add a new secret を選択します。
- Name は BACKLOG_API_KEY とし、 Value に API キーをそのまま貼り付けます。
- 登録します。
collaborator による workflow の実行を制限
プライベートリポジトリの場合は下記の操作を行う必要はありません。
パブリックリポジトリの場合は、collaborator からの workflow の実行を制限してください。
パブリックリポジトリの場合は、collaborator からの workflow の実行を制限してください。
- Setting → Actions → Fork pull request workflows from outside collaborators を開きます。
- Require approval for all outside collaborators を選択します。
Workflow の作成
GitHub Actions workflow を作成します (例: .github/workflows/backlog-notify.yml )。
下記のような形式である必要があります。
name: Backlog Notify
on:
push:
pull_request:
types:
- opened
- reopened
- ready_for_review
- closed
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: Backlog Notify
uses: bicstone/backlog-notify@v4
with:
project_key: PROJECT_KEY
api_host: example.backlog.jp
api_key: ${{ secrets.BACKLOG_API_KEY }}
高度な設定
Workflow syntax for GitHub Actions - GitHub Docs を参照に実行する条件を制御することができます。
また、コメントのフォーマットや、メッセージを解析する際の正規表現などをカスタマイズすることもできます。
name: Backlog Notify
on:
push:
branches:
- main
pull_request:
types:
- opened
- reopened
- ready_for_review
- closed
branches:
- releases/**
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: Backlog Notify
uses: bicstone/backlog-notify@v4
with:
# 必須設定 (The following are required settings)
project_key: PROJECT_KEY
api_host: example.backlog.jp
api_key: ${{ secrets.BACKLOG_API_KEY }}
# 任意設定 (The following are optional settings)
fix_keywords: |-
#fix
#fixes
#fixed
close_keywords: |-
#close
#closes
#closed
push_comment_template: |-
<%= commits[0].author.name %>さんが[<%= ref.name %>](<%= ref.url %>)にプッシュしました
<% commits.forEach(commit=>{ %>
+ [<%= commit.comment %>](<%= commit.url %>) (<% print(commit.id.slice(0, 7)) %>)<% }); %>
pr_opened_comment_template: |-
<%= sender.login %>さんがプルリクエストを作成しました
+ [<%= title %>](<%= pr.html_url %>) (#<%= pr.number %>)
pr_reopened_comment_template: |-
<%= sender.login %>さんがプルリクエストを作成しました
+ [<%= title %>](<%= pr.html_url %>) (#<%= pr.number %>)
pr_ready_for_review_comment_template: |-
<%= sender.login %>さんがプルリクエストを作成しました
+ [<%= title %>](<%= pr.html_url %>) (#<%= pr.number %>)
pr_closed_comment_template: |-
<%= sender.login %>さんがプルリクエストをクローズしました
+ [<%= title %>](<%= pr.html_url %>) (#<%= pr.number %>)
pr_merged_comment_template: |-
<%= sender.login %>さんがプルリクエストをマージしました
+ [<%= title %>](<%= pr.html_url %>) (#<%= pr.number %>)
commit_message_reg_template: "\
^\
(<%= projectKey %>\\-\\d+)\\s?\
(.*?)?\\s?\
(<% print(fixKeywords.join('|')) %>|<% print(closeKeywords.join('|')) %>)?\
$\
"
pr_title_reg_template: "\
^\
(<%= projectKey %>\\-\\d+)\\s?\
(.*?)?\\s?\
(<% print(fixKeywords.join('|')) %>|<% print(closeKeywords.join('|')) %>)?\
$\
"
fix_status_id: 3
close_status_id: 4
設定一覧
設定名 | 説明 |
---|---|
project_key | Backlog プロジェクトキー (必須) |
api_host | Backlog のホスト (必須) |
api_key | Backlog API キー (必須) |
fix_keywords | 処理済みにするキーワード |
close_keywords | 完了にするキーワード |
push_comment_template | プッシュ時のコメント雛形 |
pr_opened_comment_template | プルリクエストオープン時のコメント雛形 |
pr_reopened_comment_template | プルリクエスト再オープン時のコメント雛形 |
pr_ready_for_review_comment_template | プルリクエスト下書き解除時のコメント雛形 |
pr_closed_comment_template | プルリクエストクローズ時のコメント雛形 |
pr_merged_comment_template | プルリクエストマージ時のコメント雛形 |
commit_message_reg_template | コミットメッセージ解析の正規表現雛形 |
pr_title_reg_template | プルリクエストタイトル解析の正規表現雛形 |
fix_status_id | 処理済みの 状態 ID |
close_status_id | 完了の 状態 ID |
push_comment_template
プッシュ時のコメントの雛形を変更できます。
構文については lodash/template をご参照ください。
構文については lodash/template をご参照ください。
使用可能な変数
変数名 | 型 |
---|---|
commits | ParsedCommit[] |
ref | ParsedRef |
ParsedCommit
変数名 | 型 |
---|---|
id | string |
tree_id | string |
distinct | boolean |
message | string |
timestamp | string |
url | string |
author | Committer |
committer | Committer |
added | string[] |
modified | string[] |
removed | string[] |
issueKey | string |
comment | string |
keywords | string |
isFix | boolean |
isClose | boolean |
ParsedRef
変数名 | 型 |
---|---|
name | string |
url | string |
Committer
変数名 | 型 |
---|---|
name | string |
string | null | |
date | string | undefined |
username | string | undefined |
pr_*_comment_template
プルリクエストイベントのコメントの雛形を変更できます。
構文については lodash/template をご参照ください。
構文については lodash/template をご参照ください。
使用可能な変数
変数名 | 型 |
---|---|
pr | PullRequest |
action | "opened" | "reopened" | "ready_for_review" | "closed" ※1 |
sender | User |
issueKey | string |
title | string ※2 |
keywords | string |
isFix | boolean |
isClose | boolean |
※1 マージとクローズは共に "closed" となります。マージかどうか判別したい場合は pr.merged を参照ください。
※2 課題キーとキーワードを除いたタイトルです。加工前のタイトルは pr.title を参照ください。
※2 課題キーとキーワードを除いたタイトルです。加工前のタイトルは pr.title を参照ください。
PullRequest
Get a pull request - GitHub Docs の Response schema をご参照ください。
User
Get the authenticated user - GitHub Docs の Response schema をご参照ください。
commit_message_reg_template
コミットメッセージ解析の正規表現雛形を変更できます。
構文については lodash/template をご参照ください。
構文については lodash/template をご参照ください。
使用可能な変数
変数名 | 型 |
---|---|
projectKey | string |
fixKeywords | string[] |
closeKeywords | string[] |
pr_title_reg_template
プルリクエストタイトル解析の正規表現雛形を変更できます。
構文については lodash/template をご参照ください。
構文については lodash/template をご参照ください。
使用可能な変数
変数名 | 型 |
---|---|
projectKey | string |
fixKeywords | string[] |
closeKeywords | string[] |
よくある質問と回答
- 何をプッシュしても実行に失敗し、ログに 401 エラーとある
API キーが誤っている可能性があります。 - プロジェクトキーと課題キーが正しいのに実行に失敗し、ログに 404 エラーとある
該当 API キーのユーザーがプロジェクトに参加していない可能性があります。
料金について
GitHub Actions は処理時間で課金されるためできるだけ実行時間を減らすよう設計しています。
ncc を活用し、単一のファイルにコンパイルしたNode.jsのプログラムとなっており、数秒で実行が完了します。2コミットでは3秒でした。とてもエコです。
まとめ
もし、便利だと思ったらスター頂ければ幸いです。実はしばらく Backlog を使用しておらず、多くの方に使用していただいているという責任感で維持している状態です。。反響があると、維持するモチベーションに繋がります。
よろしくお願いいたします。
Backlog Notify · Actions · GitHub Marketplace
https://github.com/marketplace/actions/backlog-notify