|
| 1 | +name: Delete Review App |
| 2 | + |
| 3 | +on: |
| 4 | + workflow_call: |
| 5 | + inputs: |
| 6 | + control_plane_flow_ref: |
| 7 | + description: Git ref used to load shared cpflow composite actions. |
| 8 | + required: false |
| 9 | + type: string |
| 10 | + default: main |
| 11 | + |
| 12 | +permissions: |
| 13 | + contents: read |
| 14 | + issues: write |
| 15 | + pull-requests: write |
| 16 | + |
| 17 | +concurrency: |
| 18 | + group: cpflow-delete-review-app-${{ github.event.pull_request.number || github.event.issue.number || github.event.inputs.pr_number }} |
| 19 | + # Deletions must not cancel each other mid-flight — a cancelled `cpln` delete can leave |
| 20 | + # partial state behind. Let the in-progress deletion finish before the next run starts. |
| 21 | + cancel-in-progress: false |
| 22 | + |
| 23 | +env: |
| 24 | + APP_NAME: ${{ vars.REVIEW_APP_PREFIX }}-${{ github.event.pull_request.number || github.event.issue.number || github.event.inputs.pr_number }} |
| 25 | + CPLN_ORG: ${{ vars.CPLN_ORG_STAGING }} |
| 26 | + PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number || github.event.inputs.pr_number }} |
| 27 | + |
| 28 | +jobs: |
| 29 | + delete-review-app: |
| 30 | + if: | |
| 31 | + (github.event_name == 'issue_comment' && |
| 32 | + github.event.issue.pull_request && |
| 33 | + contains(fromJson('["+review-app-delete","+review-app-delete\n","+review-app-delete\r\n"]'), github.event.comment.body) && |
| 34 | + contains(fromJson('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association)) || |
| 35 | + (github.event_name == 'pull_request_target' && github.event.action == 'closed') || |
| 36 | + github.event_name == 'workflow_dispatch' |
| 37 | + runs-on: ubuntu-latest |
| 38 | + timeout-minutes: 15 |
| 39 | + |
| 40 | + steps: |
| 41 | + - name: React to delete command |
| 42 | + if: github.event_name == 'issue_comment' |
| 43 | + continue-on-error: true |
| 44 | + uses: actions/github-script@v8 |
| 45 | + with: |
| 46 | + script: | |
| 47 | + try { |
| 48 | + await github.rest.reactions.createForIssueComment({ |
| 49 | + owner: context.repo.owner, |
| 50 | + repo: context.repo.repo, |
| 51 | + comment_id: context.payload.comment.id, |
| 52 | + content: "eyes" |
| 53 | + }); |
| 54 | + } catch (error) { |
| 55 | + if (error.status === 422) { |
| 56 | + core.info("Delete command reaction already exists."); |
| 57 | + } else { |
| 58 | + throw error; |
| 59 | + } |
| 60 | + } |
| 61 | +
|
| 62 | + - name: Checkout control-plane-flow actions |
| 63 | + uses: actions/checkout@v6 |
| 64 | + with: |
| 65 | + repository: shakacode/control-plane-flow |
| 66 | + ref: ${{ inputs.control_plane_flow_ref }} |
| 67 | + path: .cpflow |
| 68 | + persist-credentials: false |
| 69 | + |
| 70 | + - name: Validate required secrets and variables |
| 71 | + id: config |
| 72 | + uses: ./.cpflow/.github/actions/cpflow-validate-config |
| 73 | + env: |
| 74 | + CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }} |
| 75 | + CPLN_ORG_STAGING: ${{ vars.CPLN_ORG_STAGING }} |
| 76 | + REVIEW_APP_PREFIX: ${{ vars.REVIEW_APP_PREFIX }} |
| 77 | + with: |
| 78 | + required: | |
| 79 | + secret:CPLN_TOKEN_STAGING |
| 80 | + variable:CPLN_ORG_STAGING |
| 81 | + variable:REVIEW_APP_PREFIX |
| 82 | + pull_request_friendly: "true" |
| 83 | + |
| 84 | + - name: Setup environment |
| 85 | + if: steps.config.outputs.ready == 'true' |
| 86 | + uses: ./.cpflow/.github/actions/cpflow-setup-environment |
| 87 | + with: |
| 88 | + token: ${{ secrets.CPLN_TOKEN_STAGING }} |
| 89 | + org: ${{ vars.CPLN_ORG_STAGING }} |
| 90 | + cpln_cli_version: ${{ vars.CPLN_CLI_VERSION }} |
| 91 | + cpflow_version: ${{ vars.CPFLOW_VERSION }} |
| 92 | + |
| 93 | + - name: Set workflow links |
| 94 | + if: steps.config.outputs.ready == 'true' |
| 95 | + uses: actions/github-script@v8 |
| 96 | + with: |
| 97 | + script: | |
| 98 | + const workflowUrl = `${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`; |
| 99 | + core.exportVariable("WORKFLOW_URL", workflowUrl); |
| 100 | + core.exportVariable( |
| 101 | + "CONSOLE_URL", |
| 102 | + `https://console.cpln.io/console/org/${process.env.CPLN_ORG}/-info` |
| 103 | + ); |
| 104 | +
|
| 105 | + - name: Create initial PR comment |
| 106 | + if: steps.config.outputs.ready == 'true' |
| 107 | + id: create-comment |
| 108 | + uses: actions/github-script@v8 |
| 109 | + with: |
| 110 | + script: | |
| 111 | + const body = [ |
| 112 | + "## 🗑️ Deleting review app...", |
| 113 | + "", |
| 114 | + `_Removing the review app for PR #${process.env.PR_NUMBER}_` |
| 115 | + ].join("\n"); |
| 116 | +
|
| 117 | + const comment = await github.rest.issues.createComment({ |
| 118 | + owner: context.repo.owner, |
| 119 | + repo: context.repo.repo, |
| 120 | + issue_number: Number(process.env.PR_NUMBER), |
| 121 | + body |
| 122 | + }); |
| 123 | + core.setOutput("comment-id", comment.data.id); |
| 124 | +
|
| 125 | + - name: Delete review app |
| 126 | + if: steps.config.outputs.ready == 'true' |
| 127 | + uses: ./.cpflow/.github/actions/cpflow-delete-control-plane-app |
| 128 | + with: |
| 129 | + app_name: ${{ env.APP_NAME }} |
| 130 | + cpln_org: ${{ vars.CPLN_ORG_STAGING }} |
| 131 | + review_app_prefix: ${{ vars.REVIEW_APP_PREFIX }} |
| 132 | + |
| 133 | + # Finalizer still runs after delete failures, but only after config validation |
| 134 | + # created the initial PR comment and workflow link env vars it updates. |
| 135 | + - name: Finalize delete status |
| 136 | + if: always() && steps.config.outputs.ready == 'true' |
| 137 | + uses: actions/github-script@v8 |
| 138 | + env: |
| 139 | + COMMENT_ID: ${{ steps.create-comment.outputs.comment-id }} |
| 140 | + JOB_STATUS: ${{ job.status }} |
| 141 | + with: |
| 142 | + script: | |
| 143 | + const commentId = Number(process.env.COMMENT_ID); |
| 144 | + const success = process.env.JOB_STATUS === "success"; |
| 145 | + const body = success |
| 146 | + ? [ |
| 147 | + "## ✅ Review App Deleted", |
| 148 | + "", |
| 149 | + `_Review app for PR #${process.env.PR_NUMBER} is deleted_`, |
| 150 | + "", |
| 151 | + `🎮 [Control Plane Console](${process.env.CONSOLE_URL})`, |
| 152 | + `📋 [View Workflow Logs](${process.env.WORKFLOW_URL})` |
| 153 | + ].join("\n") |
| 154 | + : [ |
| 155 | + "## ❌ Failed to Delete Review App", |
| 156 | + "", |
| 157 | + `_Failed to delete review app for PR #${process.env.PR_NUMBER}_`, |
| 158 | + "", |
| 159 | + `🎮 [Control Plane Console](${process.env.CONSOLE_URL})`, |
| 160 | + `📋 [View Workflow Logs](${process.env.WORKFLOW_URL})` |
| 161 | + ].join("\n"); |
| 162 | +
|
| 163 | + if (!Number.isFinite(commentId) || commentId <= 0) { |
| 164 | + core.warning("Skipping delete status comment update because no comment id was created."); |
| 165 | + return; |
| 166 | + } |
| 167 | +
|
| 168 | + await github.rest.issues.updateComment({ |
| 169 | + owner: context.repo.owner, |
| 170 | + repo: context.repo.repo, |
| 171 | + comment_id: commentId, |
| 172 | + body |
| 173 | + }); |
0 commit comments