feat: add commentId to support multiple runs in the same PR

push-based · Jul 13, 2023 · 6445167 · 6445167
2 parents 750de97 + c15945d
commit 6445167
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 8 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -27,14 +27,21 @@ jobs:
           add: '*'
       - name: test-unit:action
         run: npm run nx test action
-      - name: run:action
-        id: localRun
+      - name: run:action ( e2e test run for real output )
         uses: ./
         with:
+          commentId: test-e2e-first-run
           dryRun: off
           verbose: on
           url: https://google.com
           ufPath: ./user-flows
           outPath: ./packages/user-flow-gh-action-e2e/measures
           format: html,json
           rcPath: ./.user-flowrc.json
+      - name: run:action ( dummy run for to test multiple comments )
+        uses: ./
+        with:
+          commentId: test-e2e-second-run
+          dryRun: on
+          ufPath: ./user-flows/flow.uf.ts
+          rcPath: ./.user-flowrc.json
diff --git a/.github/workflows/user-flow_ci.yml b/.github/workflows/user-flow_ci.yml
@@ -33,6 +33,7 @@ jobs:
         id: localRun
         uses: ./dist/packages/user-flow-gh-action/
         with:
+          commentId: test-e2e-the-outputs
           dryRun: off
           verbose: on
           url: https://google.com

diff --git a/.user-flowrc.json b/.user-flowrc.json
@@ -1,7 +1,12 @@
 {
-  "collect": {},
+  "collect": {
+    "url": "https://google.com",
+    "ufPath": "./user-flows"
+  },
   "persist": {
-    "budgets": []
+    "budgets": [],
+    "outPath": "./packages/user-flow-gh-action-e2e/measures",
+    "format": ["json"]
   },
   "assert": {}
 }
diff --git a/README.md b/README.md
@@ -8,8 +8,9 @@ It automatically detects flows, executes them and produces md reports as comment
 **Inputs:**  
 | Name                         |  Type     | Default                     |  Description                                                                                               |  
 |------------------------------| --------- | --------------------------- |----------------------------------------------------------------------------------------------------------- |  
-| **`--customScript`**         | `string`  | `undefined`                 | PCustom way to execute user-flow (helpfule if the default way of execution is not given)                   |  
-| **`--rcPath`**               | `string`  | `./user-flowrc.json`        | Path to user-flow.config.json. e.g. `./user-flowrc.json`                                                   |  
+| **`--commentId`**            | `string`  | `user flow summary report`  | Id used to identify a comment in the PR (useful if multiple actions run user-flow for the same PR)  |  
+| **`--customScript`**         | `string`  | `undefined`                 | Custom way to execute user-flow (helpfule if the default way of execution is not given)                    |  
+| **`--rcPath`**               | `string`  | `./user-flowrc.json`        | Path to `.user-flowrc.json`. e.g. `./user-flowrc.server.json`                                                   |  
 | **`--verbose`**              | `string`  | `off`                       | Run with verbose logging (only 'on' and 'off' is possible)                                                 |  
 | **`--dryRun`**               | `string`  | `off`                       | Run in `dryRun` mode (only 'on' and 'off' is possible)                                                     |  
 

diff --git a/action.yml b/action.yml
@@ -2,6 +2,10 @@ name: 'Lighthouse User Flow CI Action'
 description: "Audit URL's using Lighthouse user flow and test performance within PR's"
 inputs:
   # GLOBAL ============================================
+  commentId:
+    description: 'A custom id to identify a comments in a PR'
+    required: false
+    default: "user flow summary report"
   customScript:
     description: 'A custom way to execute userflow. This is helpful if another lib wraps the userflow execution in the CI'
     required: false
@@ -71,7 +75,7 @@ runs:
       uses: marocchino/sticky-pull-request-comment@v2
       with:
         hide_and_recreate: true # collapse old comment & append new comment at the end
-        header: user flow summary report
+        header: ${{ inputs.commentId }}
         message: ${{ steps.ruf.outputs.resultSummary }}
 branding:
   icon: 'bar-chart-2' # un-sorted bar chart

diff --git a/packages/action/src/action.yml b/packages/action/src/action.yml
@@ -2,6 +2,10 @@ name: 'Lighthouse User Flow CI Action'
 description: "Audit URL's using Lighthouse user flow and test performance within PR's"
 inputs:
   # GLOBAL ============================================
+  commentId:
+    description: 'A custom id to identify a comments in a PR'
+    required: false
+    default: "user flow summary report"
   customScript:
     description: 'A custom way to execute userflow. This is helpful if another lib wraps the userflow execution in the CI'
     required: false
@@ -71,7 +75,7 @@ runs:
       uses: marocchino/sticky-pull-request-comment@v2
       with:
         hide_and_recreate: true # collapse old comment & append new comment at the end
-        header: user flow summary report
+        header: ${{ inputs.commentId }}
         message: ${{ steps.ruf.outputs.resultSummary }}
 branding:
   icon: 'bar-chart-2' # un-sorted bar chart