cirrusmd / github-action-clean-docker-packages

GitHub Action to clean Docker packages stored in GitHub

github-action-clean-docker-packages

This action will clean up the oldest Docker packages hosted on GitHub. This is intended to be run in the GitHub repo where the package exists. This action differs from others in that it aims to try an keep the most recent 100 (or less) packages, as opposed to removing specific versions.

Please read information on the GraphQL query we use to accomplish this here. This mutation is in "preview" as per GitHub docs.

Inputs

gh-token

Required a token which has the ability to remove packages in the repo.

docker-package

Required the name of the docker-package you'd like to remove versions of.

num-keep

Optional the number of most recent images to keep. Default: 100

dry-run

Optional removing packages can be scary so this will show you what we would remove (true/false).

Outputs

packages-cleaned

a list of packages that were cleaned/removed from the repository

Example usage

uses: cirrusmd/[email protected]
with:
  gh-token: ${{ secrets.YOUR_GH_TOKEN_SECRET }}
  docker-package: 'dockerImage'
  dry-run: true # enable dry-run just to test it 

Packaging:

1. Make any necessary changes to the src/ and test/ directories.
2. ensure that ncc is installed npm i -g @vercel/ncc
3. package ncc build src/repoclean.js --license LICENSE
4. ensure that dist/ is up-to-date