Pull Request Ready for Review #30398
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Pull Request Ready for Review | |
| on: | |
| pull_request: | |
| types: [opened, reopened, ready_for_review, converted_to_draft, review_requested, review_request_removed, labeled, unlabeled] | |
| workflow_run: | |
| workflows: ["Code Checks", "Check CODEOWNERS Entries", "Code Health Report", "Audit Service Tags"] | |
| types: [completed] | |
| jobs: | |
| get-pr-data: | |
| name: Get PR Data | |
| runs-on: ubuntu-latest | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| outputs: | |
| pr_number: ${{ steps.get_pr_data.outputs.pr_number }} | |
| pr_draft: ${{ steps.get_pr_data.outputs.pr_draft }} | |
| pr_labels: ${{ steps.get_pr_data.outputs.pr_labels }} | |
| pr_requested_teams: ${{ steps.get_pr_data.outputs.pr_requested_teams }} | |
| steps: | |
| - name: Get pull_request data | |
| id: get_pr_data | |
| run: | | |
| if ${{ github.event_name == 'pull_request' }}; then | |
| echo "pr_number=${{ github.event.pull_request.number }}" >> $GITHUB_OUTPUT | |
| echo "pr_draft=${{ github.event.pull_request.draft }}" >> $GITHUB_OUTPUT | |
| echo "pr_labels=$(echo '${{ toJSON(github.event.pull_request.labels.*.name) }}' | jq -c '.')" >> $GITHUB_OUTPUT | |
| echo "pr_requested_teams=$(echo '${{ toJSON(github.event.pull_request.requested_teams.*.name) }}' | jq -c '.')" >> $GITHUB_OUTPUT | |
| elif ${{ github.event_name == 'workflow_run' }}; then | |
| if ${{ github.event.workflow_run.event == 'push' }}; then | |
| HEAD_BRANCH="${{ github.event.workflow_run.head_branch }}" | |
| echo "Workflow was triggered by push to $HEAD_BRANCH. Labeling not required." | |
| exit 0 | |
| elif ${{ toJSON(github.event.workflow_run.pull_requests) != '[]' }}; then | |
| PR_NUMBER="${{ github.event.workflow_run.pull_requests[0].number }}" | |
| echo "pr_number=${PR_NUMBER}" >> $GITHUB_OUTPUT | |
| # Fetch PR details from GitHub API | |
| PR_INFO=$(gh api /repos/${{ github.repository }}/pulls/${PR_NUMBER} --jq '{ | |
| draft: .draft, | |
| labels: [.labels[].name], | |
| requested_teams: [.requested_teams[].slug] | |
| }') | |
| # Extract and store individual fields | |
| echo "pr_draft=$(echo "$PR_INFO" | jq -r '.draft')" >> $GITHUB_OUTPUT | |
| echo "pr_labels=$(echo "$PR_INFO" | jq -c '.labels')" >> $GITHUB_OUTPUT | |
| echo "pr_requested_teams=$(echo "$PR_INFO" | jq -c '.requested_teams')" >> $GITHUB_OUTPUT | |
| else | |
| echo "Workflow run has no associated pull requests. Labeling not performed." | |
| exit 0 | |
| fi | |
| else | |
| echo "event_name: ${{ github.event_name }}" | |
| echo "Pull Request not successfully retrieved." | |
| exit 1 | |
| fi | |
| handle-draft-state: | |
| name: Handle Draft State | |
| needs: get-pr-data | |
| if: needs.get-pr-data.outputs.pr_draft == 'true' | |
| runs-on: ubuntu-latest | |
| permissions: write-all | |
| steps: | |
| - name: Remove ready-for-backend-review label | |
| uses: actions-ecosystem/action-remove-labels@v1 | |
| with: | |
| number: ${{ needs.get-pr-data.outputs.pr_number }} | |
| labels: ready-for-backend-review | |
| check-backend-requirement: | |
| name: Check Backend Requirement | |
| needs: get-pr-data | |
| if: needs.get-pr-data.outputs.pr_draft == 'false' | |
| runs-on: ubuntu-latest | |
| permissions: write-all | |
| 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 }} | |
| outputs: | |
| backend_approval_required: ${{ steps.check_backend_requirement.outputs.backend_approval_required }} | |
| steps: | |
| - name: Check Backend Requirement | |
| id: check_backend_requirement | |
| if: ${{ contains(fromJSON(env.pr_requested_teams), 'backend-review-group') }} | |
| run: | | |
| echo "backend_approval_required=true" >> $GITHUB_OUTPUT | |
| - name: Remove require-backend-approval label | |
| uses: actions-ecosystem/action-remove-labels@v1 | |
| if: steps.check_backend_requirement.outputs.backend_approval_required == 'false' && contains(env.pr_labels, 'require-backend-approval') | |
| with: | |
| number: ${{ env.pr_number }} | |
| labels: require-backend-approval | |
| - name: Add require-backend-approval label | |
| uses: actions-ecosystem/action-add-labels@v1 | |
| if: steps.check_backend_requirement.outputs.backend_approval_required == 'true' | |
| with: | |
| number: ${{ env.pr_number }} | |
| labels: require-backend-approval | |
| ready_for_review: | |
| name: Ready for Review | |
| needs: [get-pr-data, check-backend-requirement] | |
| if: needs.check-backend-requirement.outputs.backend_approval_required == 'true' | |
| runs-on: ubuntu-latest | |
| permissions: write-all | |
| env: | |
| pr_number: ${{ needs.get-pr-data.outputs.pr_number }} | |
| pr_labels: ${{ needs.get-pr-data.outputs.pr_labels }} | |
| steps: | |
| - name: Configure AWS Credentials | |
| uses: aws-actions/[email protected] | |
| with: | |
| aws-access-key-id: ${{ secrets.aws_access_key_id }} | |
| aws-secret-access-key: ${{ secrets.aws_secret_access_key }} | |
| aws-region: "us-gov-west-1" | |
| - name: Get bot token from Parameter Store | |
| uses: marvinpinto/action-inject-ssm-secrets@latest | |
| with: | |
| ssm_parameter: /devops/VA_VSP_BOT_GITHUB_TOKEN | |
| env_variable_name: VA_VSP_BOT_GITHUB_TOKEN | |
| - name: Check for failure labels | |
| id: audit_pr_labels | |
| run: | | |
| if \ | |
| ${{ contains(env.pr_labels, 'audit-service-failure') }} || \ | |
| ${{ contains(env.pr_labels, 'code-health-failure') }} || \ | |
| ${{ contains(env.pr_labels, 'codeowners-addition-failure') }} || \ | |
| ${{ contains(env.pr_labels, 'codeowners-delete-failure') }} || \ | |
| ${{ contains(env.pr_labels, 'lint-failure') }} || \ | |
| ${{ contains(env.pr_labels, 'test-failure') }} ; then | |
| echo "failures_detected=true" >> $GITHUB_OUTPUT | |
| echo "Failure labels detected." | |
| else | |
| echo "failures_detected=false" >> $GITHUB_OUTPUT | |
| echo "No failure labels detected." | |
| fi | |
| - name: Get backend-review-group members | |
| id: get_team_members | |
| if: contains(env.pr_labels, 'require-backend-approval') | |
| uses: octokit/[email protected] | |
| with: | |
| route: GET /orgs/department-of-veterans-affairs/teams/backend-review-group/members | |
| env: | |
| GITHUB_TOKEN: ${{ env.VA_VSP_BOT_GITHUB_TOKEN }} | |
| - name: Get PR reviews | |
| id: get_pr_reviews | |
| if: contains(env.pr_labels, 'require-backend-approval') | |
| uses: octokit/[email protected] | |
| with: | |
| route: GET /repos/${{ github.repository }}/pulls/${{ env.pr_number }}/reviews | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Verify backend-review-group approval | |
| id: verify_approval | |
| if: contains(env.pr_labels, 'require-backend-approval') | |
| run: | | |
| BACKEND_REVIEWERS=$(cat <<'EOF' | jq -r '.[].login' | tr '\n' '|' | sed 's/|$//' | |
| ${{ steps.get_team_members.outputs.data }} | |
| EOF | |
| ) | |
| APPROVALS=$(cat <<'EOF' | jq -r '.[] | select(.state == "APPROVED") | .user.login' | grep -iE "$BACKEND_REVIEWERS" | wc -l | |
| ${{ steps.get_pr_reviews.outputs.data }} | |
| EOF | |
| ) | |
| echo "Number of backend-review-group approvals: $APPROVALS" | |
| if [ "$APPROVALS" -eq 0 ]; then | |
| echo "approval_status=required" >> $GITHUB_OUTPUT | |
| else | |
| echo "approval_status=confirmed" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Add ready-for-backend-review label | |
| uses: actions-ecosystem/action-add-labels@v1 | |
| if: | | |
| steps.audit_pr_labels.outputs.failures_detected == 'false' && | |
| steps.verify_approval.outputs.approval_status == 'required' | |
| with: | |
| number: ${{ env.pr_number }} | |
| labels: ready-for-backend-review | |
| - name: Remove ready-for-backend-review label | |
| uses: actions-ecosystem/action-remove-labels@v1 | |
| if: | | |
| ( | |
| steps.audit_pr_labels.outputs.failures_detected == 'true' || | |
| steps.verify_approval.outputs.approval_status == 'confirmed' | |
| ) && | |
| contains(env.pr_labels, 'ready-for-backend-review') | |
| with: | |
| number: ${{ env.pr_number }} | |
| labels: ready-for-backend-review |