Backlog Notify

Notify commit messages to Backlog.com issue.

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

⚠️ プライベートリポジトリでの使用を想定しています。パブリックリポジトリでは使用しないでください。

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

⚠️ 個人が開発した Action です。Backlog へのお問い合わせはご遠慮ください。

設定方法

BOT アカウントの作成
1. Backlog のプロジェクトに移動します。
2. プロジェクト設定 →参加ユーザー→ 新しいユーザの追加はこちらから を選択します。
3. クラシックプランの場合は 一般ユーザ 、新プランの場合は ゲスト を選択します。
4. 登録します。
API キーの取得
1. 登録した BOT アカウントにログインします。
2. 個人設定 → API → 登録 で発行します。
API キーの登録
1. GitGub のリポジトリページに移動します。
2. Setting → Secrets → Add a new secret を選択します。
3. Name は BACKLOG_API_KEY とし、 Value に API キーをそのまま貼り付けます。
4. 登録します。

GitHub Actions workflow の作成

GitGubのリポジトリページに移動します。
Actions → New workflow → Set up a workflow yourself を選択します。
main.yml を backlog-notify などの名前に変更します。

入力欄にYAMLを下記を参考に設定します。

name: Backlog Notify
on: push
jobs:
  backlog:
    runs-on: ubuntu-latest
    steps:
      - name: Backlog Notify
        uses: bicstone/backlog-notify@master
        env:
          PROJECT_KEY: PROJECT_KEY
          API_HOST: example.backlog.jp
          API_KEY: ${{ secrets.BACKLOG_API_KEY }}

Start commit をクリックしてコミットとプッシュします。

使用方法

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

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

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

PROJECT-123 不具合修正 #fix

環境変数一覧

変数名	説明	必須
PROJECT_KEY	プロジェクトキー	○
API_HOST	APIのURL	○
API_KEY	APIキー	○

よくある質問

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

ライセンス

MIT License

suzuken / backlog-notify