Merge branch 'master' of ssh://github.com/catchpoint/workflow-telemet…

…ry-action

.github/workflows/build.yml

@@ -10,11 +10,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - run: npm install
       - run: npm run all
       - name: Verify no unstage changes

.github/workflows/release.yml

@@ -16,17 +16,17 @@ jobs:
   update-version:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.FORESIGHT_GITHUB_TOKEN }}
       - name: Configure Git User
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "GitHub Action"
       - name: Use Node.js 16.x
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: "16.x"
+          node-version: "20"
           registry-url: https://registry.npmjs.org
       - run: npm version ${{ github.event.inputs.version_scale }}
       - run: |
@@ -38,7 +38,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [update-version]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           # ref is required
           # see:

.github/workflows/tag.yml → .github/workflows/tag-v2.yml

@@ -1,4 +1,4 @@
-name: Tag v1
+name: tag-v2
 
 on:
   workflow_dispatch:
@@ -11,14 +11,14 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.inputs.tag }}
       - name: Configure Git User
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "GitHub Action"
-      - name: Tag ${{ github.event.inputs.tag }} as v1
+      - name: Tag ${{ github.event.inputs.tag }} as v2
         run: |
-          git tag v1 -f
+          git tag v2 -f
           git push origin --tags -f

README.md

@@ -52,7 +52,7 @@ To use the action, add the following step before the steps you want to track.
 
 ```yaml
 - name: Collect Workflow Telemetry
-  uses: catchpoint/workflow-telemetry-action@v1
+  uses: catchpoint/workflow-telemetry-action@v2
 ```
 
 ## Configuration
@@ -66,6 +66,6 @@ To use the action, add the following step before the steps you want to track.
 | `proc_trace_chart_show`      | Optional          | Enables showing traced processes in trace chart. Defaults to `true`.
 | `proc_trace_chart_max_count` | Optional          | Maximum number of processes to be shown in trace chart (applicable if `proc_trace_chart_show` input is `true`). Must be a number. Defaults to `100`.
 | `proc_trace_table_show`      | Optional          | Enables showing traced processes in trace table. Defaults to `true`.
-| `comment_on_pr`              | Optional          | Set to `true` to publish the results as comment to the PR (applicable if workflow run is triggered by PR). Defaults to `true`.
+| `comment_on_pr`              | Optional          | Set to `true` to publish the results as comment to the PR (applicable if workflow run is triggered by PR). Defaults to `true`. <br/> Requires `pull-requests: write` permission
 | `job_summary`                | Optional          | Set to `true` to publish the results as part of the [job summary page](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/) of the workflow run. Defaults to `true`.
 | `theme`                      | Optional          | Set to `dark` to generate charts compatible with Github **dark** mode. Defaults to `light`.

action.yml

@@ -8,11 +8,11 @@ inputs:
     required: false
   metric_frequency:
     description: "Metric collection frequency in seconds. Must be a number. Defaults to '5'."
-    default: 5
+    default: "5"
     required: false
   proc_trace_min_duration:
     description: "Puts minimum limit for process execution duration to be traced. Must be a number. Defaults to '-1' which means process duration filtering is not applied."
-    default: -1
+    default: "-1"
     required: false
   proc_trace_sys_enable:
     description: "Enables tracing default system processes ('aws', 'cat', 'sed', ...). Defaults to 'false'."
@@ -24,7 +24,7 @@ inputs:
     required: false
   proc_trace_chart_max_count:
     description: "Maximum number of processes to be shown in trace chart (applicable if `proc_trace_chart_show` input is `true`). Must be a number. Defaults to '100'."
-    default: 100
+    default: "100"
     required: false
   proc_trace_table_show:
     description: "Enables showing traced processes in trace table. Defaults to 'false'."
@@ -44,7 +44,7 @@ inputs:
     required: false
 
 runs:
-  using: "node16"
+  using: "node20"
   main: dist/main/index.js
   post: dist/post/index.js
 branding: