https://github.com/tyler36/backlog-linker

This GitHub action replaces Backlog issue references with links when posted onto GitHub.
https://github.com/tyler36/backlog-linker

backlog github-action

Last synced: 10 months ago
JSON representation

This GitHub action replaces Backlog issue references with links when posted onto GitHub.

• Host: GitHub
• URL: https://github.com/tyler36/backlog-linker
• Owner: tyler36
• License: gpl-3.0
• Created: 2025-02-13T07:22:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-08-18T00:37:02.000Z (10 months ago)
• Last Synced: 2025-08-18T02:27:52.618Z (10 months ago)
• Topics: backlog, github-action
• Language: JavaScript
• Homepage:
• Size: 735 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Backlog-linker

[![testing](https://github.com/tyler36/backlog-linker/actions/workflows/testing.yml/badge.svg)](https://github.com/tyler36/backlog-linker/actions/workflows/testing.yml)

[![linting](https://github.com/tyler36/backlog-linker/actions/workflows/linting.yml/badge.svg)](https://github.com/tyler36/backlog-linker/actions/workflows/linting.yml)

[![Dependabot Updates](https://github.com/tyler36/backlog-linker/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/tyler36/backlog-linker/actions/workflows/dependabot/dependabot-updates)

## Overview

This GitHub action replaces Backlog issue references with links when posted onto GitHub.

Given the following comment:

`This fixes #issue-123.` becomes `This fixes [#issue-123](https://example.com/view/issue-123).`

## Usage

Add a workflow to `.github/workflows` similar to the below example:

```yml

on:

  issue_comment:

    types: [created, edited]

jobs:

  comment-notes:

    runs-on: ubuntu-latest

    name: 'backlog-linker'

    permissions:

      contents: write

      issues: write

    steps:

      # To use this repository's private action,

      # you must check out the repository

      - name: Checkout

        uses: actions/checkout@v4

      - name: Commit notes

        uses: tyler36/backlog-linker

        with:

          github-token: ${{ secrets.GITHUB_TOKEN }}

          backlog-url: ${{ secrets.BACKLOG_URL }}

          backlog-project-id: ${{ secrets.BACKLOG_PROJECT_ID }}

```

### Configuration

This action requires configuration before usage.

It is recommended to add these as GitHub secrets to prevent their display in other actions or logs.

| Name                 | Required | Description                      |

| -------------------- | :------: | -------------------------------- |

| `backlog-url`        |    ✅    | URL to Backlog workspace         |

| `backlog-project-id` |    ✅    | Project ID keyword to search for |

### backlog-url

This value should contain the URL to your Backlog workspace.

It will form the beginning of convert links and should include the protocol.

For example:

- 

- 

- 

### backlog-project-id

This is the project ID used by backlog.

This action will search for link hints such as `#ISSUE-123` where:

- Backlog Project ID is prefixed with a `#`, suffix with a `-` and followed by numbers.

- The above is not already surrounded by `[]`.

- Project ID is case insensitive.

- Multiple IDs may be entered, seperated by `,`.