Skip to content

Latest commit

 

History

History
174 lines (119 loc) · 6.33 KB

README.md

File metadata and controls

174 lines (119 loc) · 6.33 KB
Raw

Jira Telegram

The missing messenger for Jira's github automation integrations.

Tired of trying to remember how to link a ticket in github so its picked up by Jira automation flows? Use Jira Telegram to link them instead!

The missing link

Currently, Jira integrations do not support the Pull Request Body as a valid option for picking up tickets to use with Jira Automations.

From their documentation:

Pull requests

Do at least one of the following:

  • Include a commit in the pull request that has the issue key in the commit message. Note, the commit cannot be a merge commit.
  • Include the issue key at the beginning of the pull request title.
  • Ensure that the source branch name also includes the issue key at the beginning of the branch name. This works by default in connected Bitbucket, GitLab, GitHub, and GitHub Enterprise tools. If you create the pull request from the development panel in a Jira issue, the issue key is added automatically.

There is one option - pull request body that is missing from this list. This action serves to rectify that issue!

How

A lot of Pull Request Templates have an area for ## Issue You are Working on Goes Here - where a link to the ticket your working on would go. This should be enough for Jira to link the PR to the issue. This action uses that link to then push an empty commit back to the pull request with a commit message of the Jira ticket ID. Based on the reference rules this should be enough for any PR to be linked to Jira's automation flows.

Kick back - grab a coffee - and watch your issues automatically resolve themselves like magic!

Inputs

  • github_token:
    • required: true
    • description: 'Authorized github token to read and write to pull requests'
  • jira_host:
  • project_keys:
  • ignored_project_keys:
  • first_ticket_only:
    • required: false
    • description: 'When true - only the first Jira ticket found will be committed to the Pull Request'
  • use_pr_comment_blocks:
    • required: false
    • description: 'When true - Jira Telegram will only pick up tickets inside of the telegram comment blocks'

Examples

jobs:
  # ...
  send-telegram:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: jira-telegram
        with:
          jira_host: https://jira.mycompany.com
          github_token: ${{secrets.GH_TOKEN}}
          project_keys: 'JIRA,PROJ,OPROJ'
          ignore_project_keys: 'BACK,WACK'
          first_ticket_only: true
          use_pr_comment_blocks: true
  # ...

Using Telegram Comment Blocks

Note: defaults to false

If your team frequently lists related issues in pull request bodies - and you don't want those picked up - you can add this comment block to your pull request template:

_Tickets here will be ignored_

https://jira.mycompany.com/browse/JIRA-789

<!-- telegram -->

**Tickets here will be read**

https://jira.mycompany.com/browse/JIRA-123

<!-- end telegram -->

_Tickets here will be ignored_

https://jira.mycompany.com/browse/JIRA-456

Anything placed in between the telegram and end telegram comment blocks will be read - everything else will be ignored.

More Benefits of this approach

While Jira and Github are both fantastic tools in their own right, ticket numbers themselves are not. What is meant by that is MYPROJ-123 tells one nothing about the contents of what is being worked on - it simply just states "there is a ticket" for this pull request.

There is a finite, and rather small, amount of space to help others see what a pull request contains at a glance. Take the two following pr title examples:

  • fix: fix for JIRA-123
  • fix: bug in header component

If you're an engineer, you know that reviewing PRs take time, energy, and effort. Being able to decern quickly, and at a glance, what PRs you may be able to contribute to could end up saving you just enough time to be able to review one more PR (or go grab that coffee you've been dying for since this morning).

Plug in Jira Telegram and voila - PR titles, branches, and commit names can all go back to their normal descriptive selves.

Contributing

Code in Main

Install the dependencies

$ yarn install

Build the typescript and package it for distribution

$ yarn run build && yarn run package

Run the tests ✔️

$ yarn test

 PASS  ./index.test.js
  ✓ throws invalid number (3ms)
  ✓ wait 500 ms (504ms)
  ✓ test runs (95ms)

...

Publish to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run ncc and push the results:

$ yarn run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1

Note: We recommend using the --license option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! 🚀

See the versioning documentation

Validate

You can now validate the action by referencing ./ in a workflow in this repo (see test.yml)

uses: ./
with:
  milliseconds: 1000

See the actions tab for runs of this action! 🚀

Usage:

After testing you can create a v1 tag to reference the stable and latest V1 action.