Skip to content

RampNetwork/clicop

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CliCop

CliCop logo

CliCop is an Github Actions action that enforces pinning ClickUp ticket id reference in a PR.
I will fail if there is no task id in PR title or body.
It does not yet check if the task really exists in ClickUp.
It utilizes DangerJS to perform the check.

Inputs

github_token - Github authentification token. clickup_token - ClickUp authentification token.

Testing

The action conitains some unit tests. To run them:

npm install --only=dev
npm test

Example usage

name: CliCop

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

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

jobs:
  clicop:
    runs-on: ubuntu-latest
    steps:
      - uses: RampNetwork/github-actions/clicop@clicop-v1.0.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }} # this is passed automatically https://docs.github.com/en/actions/security-guides/automatic-token-authentication
          clickup_token: ${{ secrets.CLICKUP_TOKEN }}