PullRequest と Issue を自動で関連付ける(GitHub)

これまで手作業で Pull Request と Issue のマッピングを行っていて、それが面倒でした。
なので、それを自動化する GitHub Action を作ってみたという話です。

リポジトリ

できること

feature/issue-2-xxxxxxx のように Branch名に 関連付けたい Issue の番号を含めることで、 等で PR を作成すると、

Issue の頭にリンクが自動的に追加されます。

使い方

.github/workflows/ のディレクトリに下記のようなファイルを追加、pushします。

# add-issue-link.yml
name: 'Add issue link'
on:
  pull_request:
    types: [opened]

jobs:
  issue-link:
    runs-on: ubuntu-latest
    steps:
      - uses: tkt-actions/add-issue-links@v1.0.0
        with:
          repo-token: "${{ secrets.GITHUB_TOKEN }}"
          branch-prefix: "issue-"

branch-prefix は自由に指定でき、 {branch-prefix}{数字} のような名前のブランチが含まれる Pull Request が作成された時に、この Action が起動します。

branch-prefix を "issue-" とした場合、 issue-{数字} 例えば issue-12 のような名前のブランチが該当します。
feature/issue-3_add-action のように他の文字列が含まれても大丈夫です。

Pull Request のコメントにリンクを追加する Action

説明欄が勝手に編集されるのは気持ち悪い、みたいな方は、こちらを使ってみても良いかもしれないです。
ほぼ同じ仕組みで、こちらは説明欄の編集ではなく、コメントの追加が行われます。
(ほぼ同じというか、この Action を参考に作らせていただきましたm(_ _)m)

(本文を編集するか、コメントで追加するか、オプションをつけようか検討中)