Skip to content

A local-first personal finance app

:construction_worker: (ci) adding helper comments for failed CI jobs (#2074)

Matiss Janis Aboltinse11b65719e61
diff --git a/.github/workflows/e2e-test.yml b/.github/workflows/e2e-test.yml
index 1d48d375a8..3276e403f1 100644
--- a/.github/workflows/e2e-test.yml
+++ b/.github/workflows/e2e-test.yml
@@ -66,3 +66,38 @@ jobs:
name: desktop-client-test-results
path: packages/desktop-client/test-results/
retention-days: 30
+ - uses: actions-ecosystem/action-add-labels@v1
+ if: failure()
+ with:
+ labels: ':red_circle: VRT failing'
+ - uses: actions-ecosystem/action-remove-labels@v1
+ if: success()
+ with:
+ labels: ':red_circle: VRT failing'
+ - name: Find Comment
+ uses: peter-evans/find-comment@v2
+ id: fc
+ with:
+ issue-number: ${{ github.event.pull_request.number }}
+ comment-author: 'github-actions[bot]'
+ body-includes: VRT
+ - name: Create comment if failed
+ if: failure()
+ uses: peter-evans/create-or-update-comment@v3
+ with:
+ comment-id: ${{ steps.fc.outputs.comment-id }}
+ issue-number: ${{ github.event.pull_request.number }}
+ body: |
+ :wave: Looks like VRT (visual regression tests) are failing in this PR. This indicates a problem in the app. It could be either a bug in this PR or a visual change introduced by changing something.
+
+ To fix this: please follow [these instructions](https://github.com/actualbudget/actual/blob/master/packages/desktop-client/README.md#visual-regression) and review the output of the failing CI job to see the generated screenshots.
+
+ We look forward to reviewing this PR once all the CI jobs have passed successfully!
+ edit-mode: replace
+ - name: Update comment when CI job passes
+ if: success() && steps.fc.outputs.comment-id != ''
+ uses: peter-evans/create-or-update-comment@v3
+ with:
+ comment-id: ${{ steps.fc.outputs.comment-id }}
+ body: The VRT tests have passed! Thank you!
+ edit-mode: replace
diff --git a/upcoming-release-notes/2074.md b/upcoming-release-notes/2074.md
new file mode 100644
index 0000000000..665f73d21b
--- /dev/null
+++ b/upcoming-release-notes/2074.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [MatissJanis]
+---
+
+ci: add helpful bot comments if CI jobs fail.