[vets-api] Fix backend CI labeling bugs #19659

ryan-mcneil · 2024-11-29T17:17:14Z

Summary

General fixes:
- Rename a file and some jobs/steps to more accurately represent what they're doing.
- fix test-passing/test-failure conflict by evaluating overall result, instead of "existence" of a failure (while the job could still pass on retry
- Remove unnecessary features (decided upon in CoP channel) such as omit-backend-approval label and approval comment
- The majority of the workflow triggered by the workflow_run (after Code Checks, etc) was not running, because the workflow didn't have access to the PR (no github.event.pull_request). So I added a step (get_pr_data) to pull the PR number from the workflow_run and retrieve the PR (and set the required vars as outputs)
- Once unnecessary features were removed, the require_backend_label workflow could be easily added to ready_for_review to remove chance of race condition
- removed unnecessary checkout actions

Related issue(s)

[VETS-API] Backend CI - Fix current iteration va.gov-team#97156

Testing

Failed test adds test-failure label
Passing test adds test-passing label
Test failure/passing labels not unnecessarily removed then immediately re-added
Test failure/passing labels don't appear at same time
lint-failure added/removed properly
Code owners labels added/removed properly
[ ]

… labeling

…ckend_label job

github-actions · 2024-11-29T19:03:48Z

	1 Warning
⚠️	This PR changes `388` LoC (not counting whitespace/newlines). In order to ensure each PR receives the proper attention it deserves, we recommend not exceeding `200`. Expect some delays getting reviews. File Summary Files .github/workflows/audit_service_tags.yml (+0/-7) .github/workflows/backend-pr-labeler.yml (+1/-0) .github/workflows/check_codeowners.yml (+0/-14) .github/workflows/code_checks.yml (+33/-72) .github/workflows/ready_for_review.yml (+130/-46) .github/workflows/require_backend_label.yml (+0/-47) .github/workflows/{be_review_prs.yml => require_be_approval.yml} (+8/-30) Note: We exclude files matching the following when considering PR size: `.csv, .json, .tsv, .txt, .md, Gemfile.lock, app/swagger, modules/mobile/docs, spec/fixtures/, spec/support/vcr_cassettes/, modules/mobile/spec/support/vcr_cassettes/, db/seeds, modules/vaos/app/docs, modules/meb_api/app/docs, modules/appeals_api/app/swagger/, .bru, *.pdf` Big PRs are difficult to review, often become stale, and cause delays.

Generated by 🚫 Danger

.github/workflows/ready_for_review.yml

ryan-mcneil · 2024-11-29T19:31:19Z

.github/workflows/audit_service_tags.yml

@@ -21,14 +21,6 @@ jobs:
    steps:
      - uses: actions/checkout@v4

-      - name: Remove Review label


Handled in ready-for-review

ryan-mcneil · 2024-11-29T19:32:00Z

.github/workflows/check_codeowners.yml

@@ -20,14 +20,6 @@ jobs:
      with:
        fetch-depth: 2

-    - name: Remove Review label


Handled in ready-for-review

ryan-mcneil · 2024-11-29T19:33:33Z

.github/workflows/code_checks.yml

+      - name: Set Test Status
+        id: test-status
+        if: always()
+        run: |
+          if [ "${{ job.status }}" = "success" ]; then
+            echo "status=success" >> $GITHUB_OUTPUT
+          else
+            echo "status=failure" >> $GITHUB_OUTPUT
+          fi


By capturing the result, we can make sure only one of the two labels gets set at a time

ryan-mcneil · 2024-11-29T19:34:41Z

.github/workflows/ready_for_review.yml

    types: [completed]
 jobs:
-  ready_for_review:
+  get-pr-data:


workflow_run didn't have access to the PR, so this job retrieves it properly

ryan-mcneil · 2024-11-29T19:35:16Z

.github/workflows/ready_for_review.yml

+            exit 1
+          fi
+
+  handle-draft-state:


to simplify other jobs, I handle the removal of the "ready" tag on drafts here

ryan-mcneil · 2024-11-29T19:36:02Z

.github/workflows/ready_for_review.yml

+    env:
+      pr_number: ${{ needs.get-pr-data.outputs.pr_number }}
+      pr_labels: ${{ needs.get-pr-data.outputs.pr_labels }}
+      pr_requested_teams: ${{ needs.get-pr-data.outputs.pr_requested_teams }}


set the outputs of get-pr-data job as env vars to clean up logic

rmtolmach · 2024-11-29T20:21:39Z

Your tests were failing initially (they hit the timeout bug), so I re-ran them and now they're passing. But I just realized 😕 I don't think the test-failure label got added when they failed initially. Makes me think: what are all the ways we can test this? Some ideas:

Introduce a test failure - add label
Introduce a linting failure - add label
Introduce a codeowners problem - add label
PR in draft - remove ready-for-backend-review label
get a non backend-review-group review
Approval by be-review-group makes Check Approval Requirements pass

rmtolmach

approving so we can see if this makes the automation happy. I think some more testing needs to be done, though. See comment above ☝️

rmtolmach · 2024-12-02T14:40:45Z

.github/workflows/require_be_approval.yml

  check-approval-requirements:
+    name: Check Approval Requirements


small thing, but what do you think of changing the name of one of these to "require backend review" or something. I've seen people get confused about why this check hangs.

I'll just use require-backend-approval to match the label/job name

ryan-mcneil added 6 commits November 25, 2024 17:21

remove 'omit' labels

eacf641

adjust ready_for_review for consistency

691f43f

refactor 'if' statements and remove comment

1df7b7d

rename file

755baab

move ready-for-backend-review to_ready_for_review and fix code_checks…

a9b7808

… labeling

Merge branch 'master' into rm-fix-be-labeling

f377860

ryan-mcneil requested a review from a team as a code owner November 29, 2024 17:17

github-actions bot added require-backend-approval test-passing and removed require-backend-approval labels Nov 29, 2024

va-vfs-bot temporarily deployed to rm-fix-be-labeling/main/main November 29, 2024 17:31 Inactive

properly retrive PR for workflow_run and combine redundant require_ba…

50a8178

…ckend_label job

github-actions bot added require-backend-approval and removed require-backend-approval labels Nov 29, 2024

github-advanced-security bot found potential problems Nov 29, 2024

View reviewed changes

.github/workflows/ready_for_review.yml Dismissed Show dismissed Hide dismissed

va-vfs-bot temporarily deployed to rm-fix-be-labeling/main/main November 29, 2024 19:10 Inactive

remove require_backend_label

39802c7

ryan-mcneil commented Nov 29, 2024

View reviewed changes

va-vfs-bot temporarily deployed to rm-fix-be-labeling/main/main November 29, 2024 19:31 Inactive

ryan-mcneil commented Nov 29, 2024

View reviewed changes

remove unnecessary checkout action

3982499

va-vfs-bot temporarily deployed to rm-fix-be-labeling/main/main November 29, 2024 19:40 Inactive

rmtolmach previously approved these changes Nov 29, 2024

View reviewed changes

always add labels

4262da7

ryan-mcneil dismissed rmtolmach’s stale review via 4262da7 November 29, 2024 21:49

va-vfs-bot temporarily deployed to rm-fix-be-labeling/main/main November 29, 2024 21:53 Inactive

github-actions bot added test-failure and removed test-passing labels Nov 29, 2024

add linting and test failure

88d8597

ryan-mcneil requested a review from a team as a code owner November 29, 2024 22:22

github-actions bot added the lint-failure label Nov 29, 2024

va-vfs-bot temporarily deployed to rm-fix-be-labeling/main/main November 29, 2024 22:24 Inactive

fix intentional errors, introduce codeowners error

8f9b507

va-vfs-bot temporarily deployed to rm-fix-be-labeling/main/main November 29, 2024 22:36 Inactive

github-actions bot added test-passing and removed lint-failure test-failure labels Nov 29, 2024

fix codeowners

091bdcc

va-vfs-bot temporarily deployed to rm-fix-be-labeling/main/main November 29, 2024 22:56 Inactive

rmtolmach reviewed Dec 2, 2024

View reviewed changes

change jobname to Require Backend Approval

ee44720

va-vfs-bot temporarily deployed to rm-fix-be-labeling/main/main December 2, 2024 17:34 Inactive

rjohnson2011 approved these changes Dec 2, 2024

View reviewed changes

ryan-mcneil merged commit af54f53 into master Dec 2, 2024
25 checks passed

ryan-mcneil deleted the rm-fix-be-labeling branch December 2, 2024 18:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[vets-api] Fix backend CI labeling bugs #19659

[vets-api] Fix backend CI labeling bugs #19659

ryan-mcneil commented Nov 29, 2024 •

edited

Loading

github-actions bot commented Nov 29, 2024 •

edited

Loading

Files

ryan-mcneil Nov 29, 2024

ryan-mcneil Nov 29, 2024

ryan-mcneil Nov 29, 2024

ryan-mcneil Nov 29, 2024

ryan-mcneil Nov 29, 2024

ryan-mcneil Nov 29, 2024

rmtolmach commented Nov 29, 2024 •

edited by ryan-mcneil

Loading

rmtolmach left a comment

rmtolmach Dec 2, 2024 •

edited

Loading

ryan-mcneil Dec 2, 2024

ryan-mcneil Dec 2, 2024

		check-approval-requirements:
		name: Check Approval Requirements

[vets-api] Fix backend CI labeling bugs #19659

[vets-api] Fix backend CI labeling bugs #19659

Conversation

ryan-mcneil commented Nov 29, 2024 • edited Loading

Summary

Related issue(s)

Testing

github-actions bot commented Nov 29, 2024 • edited Loading

Files

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmtolmach commented Nov 29, 2024 • edited by ryan-mcneil Loading

rmtolmach left a comment

Choose a reason for hiding this comment

rmtolmach Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryan-mcneil commented Nov 29, 2024 •

edited

Loading

github-actions bot commented Nov 29, 2024 •

edited

Loading

rmtolmach commented Nov 29, 2024 •

edited by ryan-mcneil

Loading

rmtolmach Dec 2, 2024 •

edited

Loading