AAE-22415 Deployment message cleanup

.github/actions/github-deployments-delete/action.yml

@@ -0,0 +1,30 @@
+name: Delete Github Deployments
+
+description:
+  Deletes all GitHub deployments on a given branch.
+  Used as workaround to delete the flood of messages visible on some PRs where environments are leveraged but deployments are not.
+
+inputs:
+  branch-name:
+    description: The name of the branch for the deployments
+    required: true
+  environment:
+    description: The optional environment for the deployments
+    required: false
+
+runs:
+  using: composite
+  steps:
+    - name: delete-deployments
+      uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+      env:
+        GITHUB_ACTION_PATH: ${{ github.action_path }}
+      with:
+        script: |
+          const options={
+            ref:'${{ inputs.branch-name }}',
+            environment:'${{ inputs.environment }}'
+          };
+          const githubActionPath = process.env.GITHUB_ACTION_PATH;
+          const script = require(`${githubActionPath}/deleteDeploymentScript.js`);
+          await script({github, context, options});

.github/actions/github-deployments-delete/deleteDeploymentScript.js

@@ -0,0 +1,39 @@
+module.exports = async ({github, context, options}) => {
+  const perPage = 100;
+  let page = 1;
+  let allDeployments = [];
+  const {ref,environment} = options;
+
+  while(true) {
+    const deployments = await github.rest.repos.listDeployments({
+        owner: context.repo.owner,
+        repo: context.repo.repo,
+        ref: ref,
+        per_page: perPage,
+        page: page,
+        environment: environment
+      });
+
+    allDeployments = [...allDeployments, ...deployments.data];
+    if (!deployments.data.length) {
+      break;
+    }
+    page++;
+  }
+
+  await Promise.all(
+    allDeployments.map(async (deployment) => {
+      await github.rest.repos.createDeploymentStatus({
+        owner: context.repo.owner,
+        repo: context.repo.repo,
+        deployment_id: deployment.id,
+        state: 'inactive'
+      });
+      return github.rest.repos.deleteDeployment({
+        owner: context.repo.owner,
+        repo: context.repo.repo,
+        deployment_id: deployment.id
+      });
+    })
+  );
+}

.github/dependabot.yml

@@ -209,6 +209,14 @@ updates:
       catch-all:
         patterns:
           - "*"
+  - package-ecosystem: "github-actions"
+    directory: "/.github/actions/github-deployments-delete"
+    schedule:
+      interval: "weekly"
+    groups:
+      catch-all:
+        patterns:
+          - "*"
   - package-ecosystem: "github-actions"
     directory: "/.github/actions/github-download-file"
     schedule:

docs/README.md

@@ -47,6 +47,7 @@ Here follows the list of GitHub Actions topics available in the current document
     - [git-latest-tag](#git-latest-tag)
     - [github-check-upcoming-runs](#github-check-upcoming-runs)
     - [github-deployment-create and github-deployment-status-update](#github-deployment-create-and-github-deployment-status-update)
+    - [github-deployments-delete](#github-deployments-delete)
     - [github-download-file](#github-download-file)
     - [helm-build-chart](#helm-build-chart)
     - [helm-integration-tests](#helm-integration-tests)
@@ -683,6 +684,23 @@ jobs:
           state: success
 ```
 
+### github-deployments-delete
+
+Deletes all GitHub deployments on a given branch.
+Used as workaround to delete the flood of messages visible on some PRs where environments are leveraged but deployments are not.
+
+Sample usage:
+
+```yaml
+    permissions:
+      deployments: write # This is required for deployment statuses management
+
+    steps:
+      - uses: Alfresco/alfresco-build-tools/.github/actions/github-deployments-delete@ref
+        with:
+          branch-name: ${{ github.head_ref }}
+```
+
 ### github-download-file
 
 Download a file from another repository.

version.txt

@@ -1 +1 @@
-v5.27.1
+v5.28.0