README.md

backlog-pr-link-action

GitHub Actions: Link PR to backlog issue.

Usage

# .github/workflows/backlog-pr-link.yml
name: 'Link PR to Backlog'

on:
  pull_request:
    types: [opened, edited]

jobs:
  backlog-pr-link:
    runs-on: ubuntu-latest
    steps:
      - uses: toshimaru/[email protected]
        with:
          backlog-api-key: "${{ secrets.BACKLOG_API_KEY }}"
          backlog-host: "your-org.backlog.com"

Setup

• Create a custom field named Pull Request and PR Status.

  • Custom Field: Pull Request, PR Status
  • Custom Field Type: Sentence
  • Reference
    • [English] Setting Custom fields - Backlog Enterprise
    • [Japanese] カスタム属性の設定方法 – Backlog ヘルプセンター
  • 

• Generate Backlog API key for the Action

  • Reference
    • [English] API Settings – Backlog Help Center
    • [Japanese] APIの設定 – Backlog ヘルプセンター
  • 

• Set API key to GitHub Secret

  • Recommended secret key name: BACKLOG_API_KEY
  • Reference
    • Encrypted secrets - GitHub Docs