link-github-backlog-action

How to use

1. Set your Backlog data.

You must set 2 secrets:

• BACKLOG_PROJECT_KEY
• BACKLOG_FQDN

If you don't know how to create your secrets, see this.

2. Set your workflow permissions.

This action writes a url to your pull request body, so your workflow must have write access permission.

There are 2 ways:

1. Change your workflow's default permissions. See.
2. Specify your workflow permission in the workflow file. See.

3. Use this action in your workflow.

You can use this action like this.

name: Your workflow name

on:
  pull_request:
    types: [opened]

jobs:
  your_job_name:
    runs-on: ubuntu-latest
    steps:
    - name: Set Backlog issue URL.
      uses: RikiyaOta/link-github-backlog-action@v1
      # Required.
      with:
        backlog-project-key: ${{ secrets.BACKLOG_PROJECT_KEY }}
        backlog-fqdn: ${{ secrets.BACKLOG_FQDN }}
      # Required.
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        GH_REPO: ${{ github.repository }}

Features

1. Set your Backlog issue's URL to the pull request description.

For example, you will set 2 secrets like this:

• BACKLOG_PROJECT_KEY = OUR_PRODUCT
• BACKLOG_FQDN = our-company.backlog.com

And then, you will work on a branch fix/OUR_PRODUCT-123_fix-an-important-bug.

After finishing coding, you will open a new pull request and write following description:

# Abstract

- This pull reqeust will fix an important bug.

# Notes

- This pull request is dummy.

In a result, this link-github-backlog-action will edit this pull request description like this:

https://our-company.backlog.com/view/OUR_PRODUCT-123

# Abstract

- This pull reqeust will fix an important bug.

# Notes

- This pull request is dummy.

So, you can access the Backlog issue easily.

Development

• Install act.
• Create your local files like this:

$ cd local/
$ cp github-action.env.sample github-action.env
$ cp github-action.secrets.sample github-action.secrets
$ cp pull-request.json.sample pull-request.json

• Run on local:

$ act pull_request --container-architecture linux/amd64 \
    --eventpath local/pull-request.json \
    --env-file local/github-action.env \
    --secret-file local/github-action.secrets