Repository files navigation

GitHub Actions: Link GitHub Pull Request toBacklog issue.

• BacklogPremium plan (ref.Backlog Pricing)
• Create custom field named"Pull Request" in Backlog issue

# .github/workflows/backlog-pr-link.ymlname:'Link PR to Backlog'on:pull_request:types:[opened, edited]jobs:backlog-pr-link:runs-on:ubuntu-lateststeps:      -uses:toshimaru/backlog-pr-link-action@v2.1.1with:backlog-api-key:"${{ secrets.BACKLOG_API_KEY }}"backlog-host:"your-org.backlog.com"

If the pull request doesn't contain a Backlog URL, no need to run this action.

To avoid this situation, you can skip the job by usingif expression as follows:

# Run the job only when the pull request contains a Backlog URLjobs:backlog-pr-link:runs-on:ubuntu-latestif:contains(github.event.pull_request.body, 'https://yourhost.backlog.com/')steps:      -...

• Check the pull request has a Backlog issue URL when it's opened or edited
• If it has the URL, link GitHub PR to Backlog issue

• Custom Field:Pull Request
• Custom Field Type:Sentence

• [English]Setting Custom fields - Backlog Enterprise
• [Japanese]カスタム属性の設定方法 – Backlog ヘルプセンター

• Go to Backlog API Settings page
• Generate API key for the action

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

• Go to GitHub Actions secrets page
• Add GitHub Repository secret
  • secret name:BACKLOG_API_KEY
  • secret value: {your-backlog-api-key}

• Encrypted secrets - GitHub Docs