Notify commit messages to Backlog.com issue.

プッシュされたコミットメッセージを Backlog 課題のコメントに追加する GitHub Action です。キーワードによる課題の状態変更も可能です。

個人が開発した Action です。ヌーラボさまへのお問い合わせはご遠慮ください。

1. Backlog のプロジェクトに移動します。
2. プロジェクト設定 → 参加ユーザー → 新しいユーザの追加はこちらから を選択します。
3. クラシックプランの場合は 一般ユーザ 、新プランの場合は ゲスト を選択します。
4. 登録します。
5. 登録した BOT アカウントにログインします。
6. 個人設定 → API → 登録 で API キーを発行します。

1. GitHub のリポジトリページに移動します。
2. Setting → Secrets → Add a new secret を選択します。
3. Name は BACKLOG_API_KEY とし、 Value に API キーをそのまま貼り付けます。
4. 登録します。

プライベートリポジトリの場合は下記の操作を行う必要はありません。
パブリックリポジトリの場合は、collaborator からの workflow の実行を制限してください。

1. Setting → Actions → Fork pull request workflows from outside collaborators を開きます。
2. Require approval for all outside collaborators を選択します。

GitHub Actions workflow を作成します (例: .github/workflows/backlog-notify.yml )。 下記のような形式である必要があります。

name: Backlog Notify

on: push

jobs:
  notify:
    runs-on: ubuntu-latest

    steps:
      - name: Backlog Notify
        uses: bicstone/backlog-notify@v3
        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 %> ([<% print(commit.id.slice(0, 7)) %>](<%= commit.url %>))<% }); %>
          commit_message_reg_template: "\
            ^\
            (<%= projectKey %>\\-\\d+)\\s?\
            (.*?)?\\s?\
            (<% print(fixKeywords.join('|')) %>|<% print(closeKeywords.join('|')) %>)?\
            $\
            "
          fix_status_id: 3
          close_status_id: 4

プッシュ時のコメントの雛形を変更できます。
構文については lodash/template をご参照ください。

コミットメッセージ解析の正規表現雛形を変更できます。
構文については lodash/template をご参照ください。

Backlog の Git と同様です。課題キーは先頭にある 1 つ目のキーのみ認識します。
付加機能として、コミットログで課題を操作することができます。

• #fix #fixes #fixed のどれかで処理済み
• #close #closes #closed のどれかで完了

例えば下記のようにコミットメッセージを設定してください。

PROJECT-123 不具合修正 #fix

大量にプッシュするとそのまま投稿され、 Backlog に負荷がかかるのでご注意ください。

• 何をプッシュしても実行に失敗し、ログに 401 エラーとある
  →API キーが誤っている可能性があります。

• プロジェクトキーと課題キーが正しいのに実行に失敗し、ログに 404 エラーとある
  → 該当 API キーのユーザーがプロジェクトに参加していない可能性があります。

コントリビューターの皆様に感謝いたします。

Thanks goes to these contributors.

Oishi Takanori 🤔 💻 🚧 💬 📖 👀

takeshi.kondo 🐛 💻

Kenta SUZUKI 📖

mantaroh 🤔

Hyunjoon KIM 🤔 💻

貢献はいつでも大歓迎です。事前に CONTRIBUTING.md をご確認ください。

Contributions of any kind welcome! Please read CONTRIBUTING.md.

MIT License