＃14 github のイベントを backlog に通知する

概要

リポジトリ管理は github、課題管理は backlog で行っているプロジェクトがあり、backlog 上にプルリクエストの情報を都度記載するのが大変だったため、プルリクエストが作成/クローズされたタイミングで、自動的にbacklogにコメントが登録されるようにしました。

仕組み

github actions を用いて gitイベントをトリガーし、backlog API でコメント登録をします。
backlog APIの実行には、Backlog Notifyを使用しました。
実行の条件として、プルリクエストのタイトルにBacklogの課題番号の記載が必要です。

実装

{プロジェクトルート}/.github/workflows に以下のファイルを配置します。
project_key, api_host, api_key の欄にはbacklogから取得した設定を入力します。
今回は、コミットプッシュ時はトリガー対象外とし、プルリクエストの作成/クローズのみを対象としています。

backlog-notify.yml

name: Backlog Notify

on:
  pull_request:
    types:
      - opened
      - reopened
      - ready_for_review
      - closed

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
      - name: Backlog Notify
        uses: bicstone/backlog-notify@v4.0.2
        with:
          project_key: ******
          api_host: ******
          api_key: ******

確認

上記実装後、実際にプルリクを作成してみました。
すると

狙い通り、backlogに自動でコメントが登録されました！

プルリクをマージについても

同様に、無事動作しています。
登録されるコメントの内容については、今回はデフォルトのままにしていますが、オプショナル設定で変更可能です。

最後に

今回はbacklogとgithubを連携してみました。手軽に導入できるので、運用の煩わしさで困っている方の参考になれば幸いです。
出典: https://github.com/marketplace/actions/backlog-notify