https://github.com/sbimochan/ticket-link-appender

Appends jira or other project board ticket link to description
https://github.com/sbimochan/ticket-link-appender

actions bots jira project-management

Last synced: about 2 months ago
JSON representation

Appends jira or other project board ticket link to description

• Host: GitHub
• URL: https://github.com/sbimochan/ticket-link-appender
• Owner: sbimochan
• License: mit
• Created: 2021-12-27T05:51:22.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-22T08:06:39.000Z (10 months ago)
• Last Synced: 2024-09-25T07:35:02.256Z (3 months ago)
• Topics: actions, bots, jira, project-management
• Language: JavaScript
• Homepage: https://github.com/marketplace/actions/ticket-link-appender
• Size: 192 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Ticket Link Appender

This action automatically updates your pull request by heuristically searching ticket link from your Jira or other project tracking software and appends on your pull request.

> This tool can be used with other project tracking tools like ClickUp as well. Let's explore together!

## Settings

`jira-project-url`

**Required** Add your jira link in ticket link format.

E.g:

`https://jira.atlassian.net/browse`

`ticket-regex-title`

**Optional** You can add custom regex if your PR description seems to be different but I encourage to have same standard world wide.

#### PR summary example:

`XYZ-1234: This is an amazing feature`

## Outputs

Appends ticket link in your PR description:

Jira Link: https://jira.atlassian.net/browse/JPT-1571

## Example usage

`GITHUB_TOKEN` will automatically be there.

```yaml

uses: sbimochan/[email protected]

  with:

    jira-project-url: https://jira.atlassian.net/browse

    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

### Full example

```yaml

on: pull_request

jobs:

  example_pr_link:

    runs-on: ubuntu-latest

    name: Auto ticket link appender

    steps:

      - name: Checkout

        uses: actions/checkout@v1

      - name: Append ticket link

        uses: sbimochan/[email protected]

        with:

          jira-project-url: https://jira.atlassian.net/browse

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

### Recommendations:

> Smart Commit

This makes your commits and PR summary consistent.

Check repo.