README.md

Kanar

Kanar is an Github Actions action that enforces pinning ticket id reference in a PR.
It will fail if there is no task id in PR title.
It utilizes DangerJS to perform the check.

Inputs

github_token - Github authentification token. jira_token - Jira authentification token. jira_token_user - Email of Jira user the authentification token belongs to.

Testing

The action conitains some unit tests. To run them:

npm install --only=dev
npm test

Example usage

name: Kanar

on:
  pull_request:
    - opened
    - reopened
    - synchronize
    - edited

permissions:
  contents: read
  pull-requests: write
  issues: write
  statuses: write

jobs:
  kanar:
    runs-on: ubuntu-latest
    steps:
      - uses: RampNetwork/github-actions/kanar@v2
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }} # this is passed automatically https://docs.github.com/en/actions/security-guides/automatic-token-authentication
          jira_token: ${{ secrets.JIRA_TOKEN }}
          jira_token_user: ${{ secrets.JIRA_TOKEN_USER }}