feat(deployment/delete): optimize delete of review apps environments

Signed-off-by: Emilien Escalle <[email protected]>

Author: neilime

.github/workflows/__main-ci.yml

@@ -21,6 +21,7 @@ concurrency:
 jobs:
   ci:
     uses: ./.github/workflows/__shared-ci.yml
+    secrets: inherit
 
   release:
     needs: ci

.github/workflows/__pull-request-ci.yml

@@ -12,6 +12,7 @@ permissions:
   packages: write
   pull-requests: read
   statuses: write
+  deployments: write
   # FIXME: This is a workaround for having workflow actions. See https://github.com/orgs/community/discussions/38659
   id-token: write
 
@@ -22,3 +23,4 @@ concurrency:
 jobs:
   ci:
     uses: ./.github/workflows/__shared-ci.yml
+    secrets: inherit

.github/workflows/__shared-ci.yml

@@ -16,3 +16,4 @@ jobs:
   test-action-docker-build-image:
     needs: linter
     uses: ./.github/workflows/__test-action-deployment.yml
+    secrets: inherit

.github/workflows/__test-action-deployment.yml

@@ -32,8 +32,16 @@ jobs:
           deployment-id: ${{ steps.create-deployment.outputs.deployment-id }}
           state: "in_progress"
 
+      - uses: actions/create-github-app-token@v1
+        id: generate-token
+        with:
+          app-id: ${{ vars.CI_BOT_APP_ID }}
+          private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }}
+
       - id: delete-deployment
         uses: ./actions/deployment/delete
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
 
       - name: Check delete outputs
         run: |

actions/deployment/delete/action.yml

@@ -1,21 +1,21 @@
 name: "Delete deployment(s)"
-description: "Action to delete some deployment(s) for the current ref. It also deletes the associated environment(s) if it is a review-app"
+description: "Action to delete some deployment(s) for the current ref. It also deletes the associated review apps environment(s) if any."
 author: Hoverkraft
 branding:
   icon: trash-2
   color: gray-dark
 
 inputs:
   token:
-    description: "The token to use to delete the environment(s)"
+    description: "The token to use to delete the review apps environment(s). It needs the `repo` scope."
     required: false
 
 outputs:
   deployment-ids:
-    description: "The id(s) of the deleted deployment(s). Json array format"
+    description: "The id(s) of the deleted deployment(s). Json array format."
     value: ${{ steps.delete-deployments.outputs.deployment-ids }}
   environments:
-    description: "The name(s) of the environment(s) related to  deleted deployment(s). Json array format"
+    description: "The name(s) of the environment(s) related to  deleted deployment(s). Json array format."
     value: ${{ steps.delete-deployments.outputs.environments }}
 
 runs:
@@ -66,23 +66,23 @@ runs:
             environments.add(deployment.environment);
           }
 
+          const reviewAppsEnvironments = Array.from(environments).filter((environment) => environment.startsWith('review-apps'));
+
           core.setOutput('deployment-ids', JSON.stringify(deploymentIds));
           core.setOutput('environments', JSON.stringify(Array.from(environments)));
+          core.setOutput('review-apps-environments', JSON.stringify(reviewAppsEnvironments));
 
-    - id: delete-environments
+    - id: delete-review-apps-environments
+      if: steps.delete-deployments.outputs.review-apps-environments != '[]'
       uses: actions/github-script@v7
       with:
         github-token: ${{ inputs.token }}
         script: |
-          const environments = JSON.parse(core.getInput('environments'));
-
-          // Clean up the environment if it is a review-app
-          for (const environment of environments) {
-            if (environment.startsWith('review-apps')) {
-              await github.rest.repos.deleteAnEnvironment({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                environment_name: environment,
-              });
-            }
+          const reviewAppsEnvironments = JSON.parse(`${{ steps.delete-deployments.outputs.review-apps-environments }}`);
+          for (const environment of reviewAppsEnvironments) {
+            await github.rest.repos.deleteAnEnvironment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              environment_name: environment,
+            });
           }