https://github.com/tweedegolf/cleanup-untagged-images-action

Cleanup untagged docker images
https://github.com/tweedegolf/cleanup-untagged-images-action

actions

Last synced: about 1 month ago
JSON representation

Cleanup untagged docker images

• Host: GitHub
• URL: https://github.com/tweedegolf/cleanup-untagged-images-action
• Owner: tweedegolf
• License: mit
• Created: 2024-07-12T09:21:56.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-26T11:28:34.000Z (5 months ago)
• Last Synced: 2024-07-26T12:59:20.006Z (5 months ago)
• Topics: actions
• Language: JavaScript
• Homepage:
• Size: 1.13 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Cleanup of untagged docker images in the container registry

The GitHub container registry does not automatically remove old tags or untagged

images from itself. To do this, we can setup an actions workflow that does this

for us automatically. There are two steps to this process. First, we remove any

tags that are no longer needed by adding any number of jobs refering to the

`cleanup-images-action` step. Finally we finish by adding a single

`cleanup-untagged-images-action` step. Of course, if your image creation

workflow never creates any new tags but instead always reuses the existing ones

there is no need to include any of the tag cleanup workflows. Let's look at an

example:

```yaml

name: Container Registry Cleanup

permissions:

  contents: read

  packages: write

on:

  workflow_dispatch:

  schedule:

    - cron: '30 2 * * MON'

jobs:

  cleanup:

    runs-on: ubuntu-latest

    steps:

      - uses: "tweedegolf/cleanup-images-action@main"

        with:

          package: debian

          filter: "^nightly-\\d{2}-\\d{2}-\\d{4}$"

          keep_n: 5

      - uses: "tweedegolf/cleanup-untagged-images-action@main"

        with:

          package: debian

```

In this example, we run a cleanup job that removes old nightly tagged images

first, and then removes any remaining untagged images after that. Note how this

action is only run on a schedule once a week, there is no need to run it after

every main branch update or every pull request unless lots of container builds

are happening on your repository.

### Step inputs

This step has several parameters that allow customizing the behavior:

  

    OptionRequiredDefault

  

  

    

      package

      yes

      

    

    

      Name of the container registry package

    

    

      older_than

      no

      -1

    

    

      Only remove untagged container images at least as old as this (in days),

      only works if larger than zero.

    

    

      untagged_timestamp_tolerance

      no

      10000

    

    

      Do not remove untagged container images if they have a created timestamp

      this close (in milliseconds) to a tagged container image. We do this

      because multi-arch docker containers will be pushed as separate untagged

      images to the container registry and GitHub cannot recognize them as part

      of a tagged image. Setting this option large enough prevents accidental

      deletion of one of these images.