Bump to node v20, updated documentation & dependencies

Author: frieder

.github/workflows/ci-build.yml

@@ -10,13 +10,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
           cache: npm
       - name: Run npm install
         run: npm i

.github/workflows/sonar.yml

@@ -11,13 +11,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
           cache: npm
       - name: Run npm install
         run: npm i

.github/workflows/testing.yml

@@ -0,0 +1,62 @@
+#
+# This workflow file is used for testing during local development with the help of
+# https://github.com/nektos/act.
+#
+
+name: Test GH Action
+
+on:
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Test Action
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Login
+        uses: atlassian/gajira-login@v3
+        env:
+          JIRA_BASE_URL: ${{ secrets.JIRA_URL }}
+          JIRA_USER_EMAIL: ${{ secrets.JIRA_EMAIL }}
+          JIRA_API_TOKEN: ${{ secrets.JIRA_TOKEN }}
+
+      - name: Update Fields
+        id: updatefields
+        uses: ./
+        with:
+          retries: 1
+          retryDelay: 10
+          timeout: 2000
+          failOnError: true
+          issue: ${{ vars.JIRA_ISSUES }}
+          summary: Some fancy title
+          description: Plaintext only
+          assignee: REMOVE
+          priority: Major
+          duedate: REMOVE
+          resolution: Won't Do
+          components: |
+            - Translation
+            - Search
+            - Navigation
+            - Form
+          fixversions: |
+            - 1.0.0
+            - 1.1.0
+            - 1.2.0
+            - 1.1.0
+          labels: |
+            - security
+            - sonar
+            - github
+            - vanity
+          customfields: |
+            10859: unblocked
+
+      - name: Print Outputs
+        run: |
+          echo "HAS ERRORS: ${{ steps.updatefields.outputs.hasErrors }}"
+          echo "IDs SUCCESS: ${{ steps.updatefields.outputs.successful }}"
+          echo "IDs ERROR: ${{ steps.updatefields.outputs.failed }}"

README.md

@@ -71,7 +71,6 @@ jobs:
             10050: some value
             10051: 2023-01-01
             10052: https://github.com/marketplace?type=action
-
           customfieldsJson: |
             10057: {"content":[{"content":[{"type":"text","text":"Content for the TextArea custom field"}],"type":"paragraph"}],"type":"doc","version":1}
             10058: ["value1", "value2]
@@ -355,3 +354,18 @@ with the action's output.
 3. `failed` - A list of IDs of issues that failed to get updated. This may be useful to add comments to the tickets
    in question or to report those tickets to a Slack or MSTeams channel. The format is again the same as
    with the `issues` option.
+
+## Test Action
+
+This action can be tested during development with the use of https://github.com/nektos/act.
+
+Please adapt the values accordingly both in the workflow file and in the CLI command.
+
+```
+act -W .github/workflows/testing.yml \
+    -j test \
+    -s JIRA_URL=*** \
+    -s JIRA_EMAIL=*** \
+    -s JIRA_TOKEN=*** \
+    --var JIRA_ISSUES=WEB-123
+```

action.yml

@@ -59,5 +59,5 @@ inputs:
     description: A list of custom fields with their respective values in JSON. Supports Atlassian Documents and multiple values.
     required: false
 runs:
-  using: node16
+  using: node20
   main: ./dist/index.js