https://github.com/sbimochan/jira-link-commenter

This action auto comments in pull request with Jira link to it.
https://github.com/sbimochan/jira-link-commenter

actions bots github github-actions hacktoberfest jira

Last synced: 4 days ago
JSON representation

This action auto comments in pull request with Jira link to it.

• Host: GitHub
• URL: https://github.com/sbimochan/jira-link-commenter
• Owner: sbimochan
• License: mit
• Created: 2021-12-24T06:14:40.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-18T19:37:02.000Z (4 months ago)
• Last Synced: 2024-10-31T10:39:03.538Z (15 days ago)
• Topics: actions, bots, github, github-actions, hacktoberfest, jira
• Language: JavaScript
• Homepage:
• Size: 1.06 MB
• Stars: 14
• Watchers: 2
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jira link commenter

This action auto comments in pull request with Jira link to it.

> 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

Creates a comment in your PR:

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

## Example usage

`custom-comment` is (optional)

```yaml

uses: actions/[email protected]

with:

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

  custom-comment: "Thank you for your contribution! :confetti_ball:"

```

### Full example

```yaml

on: pull_request

jobs:

  example_comment_pr:

    runs-on: ubuntu-latest

    name: Auto jira link commenter

    steps:

      - name: Checkout

        uses: actions/checkout@v1

      - name: Comment PR

        uses: sbimochan/[email protected]

        with:

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

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

          custom-comment: "Thank you for your contribution! :confetti_ball:"

```

Demo:



### Recommendations:

> Ticket link appender

This is more generic and has more flexibility on prefixes and tools you use. If you want to link the ticket link in the description itself, you can check this repository.

[Check repo.](https://github.com/sbimochan/ticket-link-appender)

> Smart Commit

This makes your commits and PR summary consistent.

Check repo.