action-delete-release-candidates

GitHub Action to delete release candidates and corresponding artefacts. This is a composite action that combines other actions, like:

• wow-actions/delete-stale-releases
• aws-actions/configure-aws-credentials

This action is used to automate the removal of release candidates that are typically created from pull requests.

Inputs

Input	Description	Required	Default
release-identifier	A string that will be used to identify the releases to be deleted (eg. "pr1234").	true
keep-latest-count	The number of matches releases to keep, ordered from latest to oldest.	true	'0'
ecr-name	The name of an ECR where to look for container images tagged with the releases we are deleting. The name is not the full URL, it is just the last bit of the URL.	false
s3-bucket	The name of a S3 bucket where to look for artefacts tagged with the releases we are deleting.	false
s3-object-key-prefix	The S3 object key prefix used to look for artefacts tagged with the releases we are deleting.	false
github-package-name	The name of the GitHub packages to delete.	false
github-package-type	The type of the GitHub packages to delete. See package_type under query parameters at https://docs.github.com/en/rest/packages/packages?apiVersion=2022-11-28#list-packages-for-an-organization--parameters.	false	'maven'
github-token	The github token used to delete the releases and tags.	true
aws-role-arn	The AWS IAM role providing access to delete artefacts from either or both ECR and S3 Bucket.	false
aws-access-key-id	The AWS access key ID providing access to delete artefacts from either or both ECR and S3 Bucket.	false
aws-secret-access-key	The runtimes where to deploy the release.	false
aws-region	The AWS region.	false	'eu-central-1'
dry-run	Whether to only print the artefacts that are matched for deletion instead of deleting them.	true	'true'

Outputs

Output	Description
releases	The releases that were identified and deleted.

Usage

The main use-case for this action is to remove releases from GitHub. In addition to that the action can also remove related objects from S3 and container images from ECR.

Remove GitHub Releases

The following workflow configuration removes GitHub releases when a pull request is closed.

name: Delete Release Candidates


on:
  pull_request:
    types: [ closed ]


jobs:
  delete-release-candidates:
    name: Delete Release Candidates
    runs-on: ubuntu-latest
    steps:
      - uses: GRESB/action-delete-release-candidates
        with:
          release-identifier: '-pr${{ github.event.number }}-rc'
          github-token: ${{ secrets.GITHUB_TOKEN }}

Remove GitHub Releases and S3 Artefacts

The following workflow configuration removes GitHub releases and corresponding artefacts from S3 when a pull request is closed.

name: Delete Release Candidates and S3 Artefacts


on:
  pull_request:
    types: [ closed ]


jobs:
  delete-release-candidates:
    name: Delete Release Candidates
    runs-on: ubuntu-latest
    steps:
      - uses: GRESB/action-delete-release-candidates
        with:
          release-identifier: '-pr${{ github.event.number }}-rc'
          s3-bucket: 'my-bucket'
          s3-object-key-prefix: 'my-app/packages'
          github-token: ${{ secrets.GITHUB_TOKEN }}
          aws-access-key-id: ${{ secrets.aws-access-key-id }}
          aws-secret-access-key: ${{ secrets.aws-secret-access-key }}

Remove GitHub Releases and ECR Container Images

The following workflow configuration removes GitHub releases and corresponding container images from ECR when a pull request is closed.

name: Delete Release Candidates and ECR Container Images


on:
  pull_request:
    types: [ closed ]


jobs:
  delete-release-candidates:
    name: Delete Release Candidates
    runs-on: ubuntu-latest
    steps:
      - uses: GRESB/action-delete-release-candidates
        with:
          release-identifier: '-pr${{ github.event.number }}-rc'
          ecr-name: 'my-app-registry'
          github-token: ${{ secrets.GITHUB_TOKEN }}
          aws-access-key-id: ${{ secrets.aws-access-key-id }}
          aws-secret-access-key: ${{ secrets.aws-secret-access-key }}

Remove GitHub Releases and packages from GitHub

The following workflow configuration removes GitHub releases and corresponding packages from GitHub when a pull request is closed.

name: Delete Release Candidates and ECR Container Images


on:
  pull_request:
    types: [ closed ]


jobs:
  delete-release-candidates:
    name: Delete Release Candidates
    runs-on: ubuntu-latest
    steps:
      - uses: GRESB/action-delete-release-candidates
        with:
          release-identifier: '-pr${{ github.event.number }}-rc'
          github-package-name: 'com.gresb.java_library'
          github-token: ${{ secrets.GITHUB_TOKEN }}