chore: rename CliCop to Kanar #PLTM-233 (#1)

README.md

@@ -1,14 +1,15 @@
-# CliCop
-![CliCop logo](clicop.png)
+# Kanar
+![Kanar logo](kanar.png)
 
 
-CliCop is an Github Actions action that enforces pinning ticket id reference in a PR.\
+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](https://danger.systems/js/) 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:
@@ -19,7 +20,7 @@ npm test
 
 ## Example usage
 ```yaml
-name: CliCop
+name: Kanar
 
 on:
   pull_request:
@@ -35,11 +36,12 @@ permissions:
   statuses: write
 
 jobs:
-  clicop:
+  kanar:
     runs-on: ubuntu-latest
     steps:
-      - uses: RampNetwork/github-actions/[email protected]
+      - 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 }}
 ```

action.yml

@@ -1,4 +1,4 @@
-name: CliCop
+name: Kanar
 description: "Run DangerJS to check if the PR is has a valid Jira ticket reference"
 
 inputs:
@@ -29,4 +29,4 @@ runs:
         JIRA_TOKEN: ${{ inputs.jira_token }}
         JIRA_TOKEN_USER: ${{ inputs.jira_token_user }}
         NODE_PATH: ${{ github.action_path }}
-      run: npx danger -i CliCop --dangerfile ${{ github.action_path }}/dangerfile.js ci
+      run: npx danger -i Kanar --dangerfile ${{ github.action_path }}/dangerfile.js ci

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "clicop",
+  "name": "kanar",
   "version": "1.0.0",
   "description": "Action that enforces pinning Jira ticket id reference in a PR using DangerJS",
   "main": "dangerfile.js",