|
1 | 1 | name: Preview cleanup |
2 | 2 |
|
| 3 | +# Runs trusted default-branch code, because it holds the Coolify webhook secret: `pull_request_target` |
| 4 | +# loads the workflow and the adapter from the pull request's base branch, and the filter below admits |
| 5 | +# only `main`. A Coolify 2xx is not proof of teardown, so this ends with a forced SSH command that |
| 6 | +# proves the host resources are gone and the slot is free. |
3 | 7 | on: |
4 | | - pull_request: |
5 | | - branches: ["**"] |
6 | | - types: [closed] |
| 8 | + pull_request_target: |
| 9 | + types: [closed, unlabeled, converted_to_draft] |
7 | 10 |
|
8 | 11 | permissions: |
9 | 12 | contents: read |
| 13 | + deployments: write |
| 14 | + pull-requests: write |
| 15 | + |
| 16 | +concurrency: |
| 17 | + group: hephaestus-preview-lifecycle |
| 18 | + queue: max |
10 | 19 |
|
11 | 20 | jobs: |
12 | 21 | cleanup: |
13 | | - name: "Preview / Delete Coolify resources" |
| 22 | + name: "Preview / Remove and verify resources" |
14 | 23 | if: >- |
15 | | - vars.COOLIFY_URL != '' && |
16 | | - vars.COOLIFY_APP_UUID != '' && |
17 | | - github.event.pull_request.head.repo.full_name == github.repository |
| 24 | + github.event.pull_request.head.repo.full_name == github.repository && |
| 25 | + (github.event.label.name == 'preview' || |
| 26 | + (github.event.action != 'unlabeled' && |
| 27 | + contains(github.event.pull_request.labels.*.name, 'preview'))) |
18 | 28 | runs-on: ubuntu-latest |
19 | | - timeout-minutes: 3 |
| 29 | + timeout-minutes: 8 |
20 | 30 | env: |
21 | 31 | COOLIFY_URL: ${{ vars.COOLIFY_URL }} |
22 | 32 | COOLIFY_APP_UUID: ${{ vars.COOLIFY_APP_UUID }} |
23 | | - COOLIFY_TOKEN: ${{ secrets.COOLIFY_API_TOKEN }} |
24 | 33 | PR_NUMBER: ${{ github.event.pull_request.number }} |
| 34 | + PR_URL: ${{ github.event.pull_request.html_url }} |
| 35 | + PR_TITLE: ${{ github.event.pull_request.title }} |
| 36 | + AUTHOR_ASSOCIATION: ${{ github.event.pull_request.author_association }} |
| 37 | + HEAD_REF: ${{ github.event.pull_request.head.ref }} |
| 38 | + HEAD_SHA: ${{ github.event.pull_request.head.sha }} |
| 39 | + # Coolify's routing key: the branch its preview application is configured for. |
| 40 | + BASE_REF: ${{ github.event.repository.default_branch }} |
| 41 | + ENVIRONMENT: preview/pr-${{ github.event.pull_request.number }} |
25 | 42 | steps: |
26 | | - - name: Delete preview containers, volumes, and network |
| 43 | + - name: Load the trusted preview adapter |
| 44 | + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 |
| 45 | + with: |
| 46 | + ref: ${{ github.sha }} |
| 47 | + persist-credentials: false |
| 48 | + sparse-checkout: | |
| 49 | + .github/actions/setup-bun |
| 50 | + package.json |
| 51 | + scripts |
| 52 | +
|
| 53 | + - name: Set up the repository's Bun version |
| 54 | + uses: ./.github/actions/setup-bun |
| 55 | + |
| 56 | + - name: Request Coolify cleanup through the signed close event |
| 57 | + id: close |
| 58 | + continue-on-error: true |
| 59 | + env: |
| 60 | + COOLIFY_WEBHOOK_SECRET: ${{ secrets.COOLIFY_PREVIEW_WEBHOOK_SECRET }} |
| 61 | + run: bun scripts/coolify-preview.ts close |
| 62 | + |
| 63 | + - name: Wait for the Coolify deployment queue to drain |
| 64 | + id: drain |
| 65 | + if: always() |
| 66 | + continue-on-error: true |
| 67 | + env: |
| 68 | + COOLIFY_TOKEN: ${{ secrets.COOLIFY_PREVIEW_READ_TOKEN }} |
| 69 | + run: bun scripts/coolify-preview.ts drain |
| 70 | + |
| 71 | + - name: Remove and verify matching host resources |
| 72 | + id: host_cleanup |
| 73 | + if: always() |
| 74 | + env: |
| 75 | + PREVIEW_HOST: ${{ vars.PREVIEW_HOST }} |
| 76 | + PREVIEW_HOST_KEY: ${{ vars.PREVIEW_HOST_KEY }} |
| 77 | + PREVIEW_SSH_USER: ${{ vars.PREVIEW_SSH_USER }} |
| 78 | + PREVIEW_SSH_PRIVATE_KEY: ${{ secrets.PREVIEW_SSH_PRIVATE_KEY }} |
| 79 | + run: bun scripts/preview-ssh.ts cleanup "${PR_NUMBER}" |
| 80 | + |
| 81 | + - name: Keep a verified cleanup tombstone |
| 82 | + id: tombstone |
| 83 | + # Proven-absent host resources are what frees the slot. A Coolify hiccup must not leave the |
| 84 | + # environment counting against admission forever; the tombstone says the nightly run still |
| 85 | + # owes Coolify a second pass. |
| 86 | + if: always() && steps.host_cleanup.outcome == 'success' |
| 87 | + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 |
| 88 | + with: |
| 89 | + script: | |
| 90 | + const controller = await import('${{ github.workspace }}/scripts/preview-controller.ts'); |
| 91 | + await controller.inactivate({ github, context, core }); |
| 92 | +
|
| 93 | + - name: Report the released preview |
| 94 | + if: always() && steps.tombstone.outcome == 'success' && github.event.pull_request.state == 'open' |
| 95 | + uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2 |
| 96 | + with: |
| 97 | + header: app-preview |
| 98 | + number: ${{ github.event.pull_request.number }} |
| 99 | + message: | |
| 100 | + ## 🧹 App Preview |
| 101 | +
|
| 102 | + ~~Preview removed~~ — the slot on the preview host is free again. |
| 103 | +
|
| 104 | + <sub>Add the `preview` label, or mark the pull request ready for review, to deploy it again.</sub> |
| 105 | +
|
| 106 | + - name: Fail if cleanup could not be verified |
| 107 | + if: >- |
| 108 | + always() && |
| 109 | + (steps.close.outcome != 'success' || |
| 110 | + steps.drain.outcome != 'success' || |
| 111 | + steps.host_cleanup.outcome != 'success') |
27 | 112 | run: | |
28 | | - set -euo pipefail |
29 | | -
|
30 | | - if [ -z "${COOLIFY_TOKEN}" ]; then |
31 | | - echo "::notice::COOLIFY_API_TOKEN is not configured; preview cleanup must be done manually." |
32 | | - exit 0 |
33 | | - fi |
34 | | -
|
35 | | - body=$(mktemp) |
36 | | - status=$(curl -sS -o "${body}" -w '%{http_code}' -X DELETE \ |
37 | | - -H "Authorization: Bearer ${COOLIFY_TOKEN}" \ |
38 | | - -H 'Accept: application/json' \ |
39 | | - --retry 3 --retry-connrefused --max-time 60 \ |
40 | | - "${COOLIFY_URL}/api/v1/applications/${COOLIFY_APP_UUID}/previews/${PR_NUMBER}") |
41 | | -
|
42 | | - if [ "${status}" -eq 404 ]; then |
43 | | - echo "::notice::PR #${PR_NUMBER} had no Coolify preview to clean up." |
44 | | - exit 0 |
45 | | - fi |
46 | | - if [ "${status}" -ge 400 ]; then |
47 | | - echo "::error::Coolify preview cleanup returned HTTP ${status}: $(cat "${body}")" |
48 | | - exit 1 |
49 | | - fi |
50 | | -
|
51 | | - echo "::notice::Deleted Coolify preview and persistent volumes for PR #${PR_NUMBER}." |
| 113 | + echo "::error::Preview cleanup was not fully verified; the nightly reconciler will retry." |
| 114 | + exit 1 |
0 commit comments