snok/container-retention-policy (snok/container-retention-policy)
### [`v3.0.0`](https://togithub.com/snok/container-retention-policy/releases/tag/v3.0.0)
[Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.2.1...v3.0.0)
##### v3.0.0
> Disclaimer: This release breaks the API of the action to a large degree. It might be wise to run the action with `dry-run: true` after upgrading.
This release is a complete rewrite of the action, tackling most if not all open issues in the issue tracker. Some of the highlights include:
- Simplifying and consolidating the inputs of the action
- Improving the runtime performance, and the initialization time of the action in CI
- Support for multi-platform packages
- Support for new token types (`secrets.GITHUB_TOKEN` and Github app tokens)
- Much better handling of GitHub API rate limits
💥 There are a lot of breaking changes, so we've included a migration guide at the bottom of this post, to make things a bit simpler.
Since the release introduces a few thousand lines of code, we expect there may be a few things left to iron out. If you run into any problems, please share them in the [v3 release issue](https://togithub.com/snok/container-retention-policy/issues/84).
***
In addition to what's mentioned above, other **new features and changes** include:
- Significant effort has been spent on improving the logging, to give better insights into what exactly is happening
- Updated license from `BSD-3` to `MIT`.
- The available syntax for `image-names` and `image-tags` previously allowed wildcards (using the `*` character). We now also allow the `?` character to express a single-character wildcard. For example, the pattern `ca?` will match `car` and `cat`. See the [wildmatch docs](https://togithub.com/becheran/wildmatch) for details.
In addition to changing the inputs of the action (more details below), there are a few other **breaking changes**:
- We'll no longer maintain mutable major and minor version tags for the action. There will be no `v3` target for the action, just `v3.0.0` and other exact versions. Mutable major version tags are generally hard to maintain and not much safer than tracking the main branch, so more precise tag tracking should reduce the likelihood of broken runs going forward. Paired with [dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot), upgrading should not be much harder than it has been.
- The [`needs-assistance` output](https://togithub.com/snok/container-retention-policy/tree/575226aa6cf28ee190c6611e8cc20d545264f443?tab=readme-ov-file#needs-github-assistance) was deleted
And in terms of **performance improvements**:
- The action has been rewritten from a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) to a [container action](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action), and the total size of the new image is < 10Mi.
- The action would previously take ~30 seconds to initialize and would require a Python runtime. The action now starts in less than a second, and runs as a standalone binary.
- The runtime of the action has been reduced, and assuming we need to delete less than 180 package versions, the action completes in, at most, a few seconds. See [this example of a recent run](https://togithub.com/snok/container-retention-policy/actions/runs/9652338073/job/26622259747). When we have to delete more than 180 package versions, there's a minute of waiting for every 180 new package versions, as a consequence of GitHub's secondary API rate limits. See the new README for details.
##### Migration guide
- The `account-type` and `org-name` inputs have been replaced with `account`, which should be set to the literal string "user" if you previously used `account-type: personal` and to the organization name otherwise:
```diff
- account-type: personal
+ account: user
```
or
```diff
- account-type: organization
- org-name: acme
+ account: acme
```
- The `filter-tags` key has been renamed to `image-tags`
```diff
- filter-tags: *-prod
+ image-tags: "*-prod"
```
- The `token-type` input has been removed. If you previously used `token-type: github-token`, then you can now instead pass the secret value to `token` and have the type of token be auto-detected:
```diff
- token-type: github-token
+ token: ${{ secrets.GITHUB_TOKEN }}
```
In other words, we've consolidated `token-type` and `token` into a single arg.
- The `skip-tags` input has been removed. If you previously used `skip-tags: latest`, you should now specify a negative glob pattern in `image-tags`.
```diff
- filter-tags: l*
- skip-tags: latest
+ image-tags: "l* !latest"
```
In other words, we've consolidated the two arguments, by adding support for the `!` operator, which means "not".
- The `filter-include-untagged` and `untagged-only` inputs were removed.
`filter-include-untagged` previously enabled you to opt-out of deleting untagged images, while `untagged-only` would allow you to opt-out of deleting tagged images. This was a bit confusing, even for me.
To make things simpler, these have been collapsed into one argument, called `tag-selection` which accepts the string values `tagged`, `untagged`, or `both`.
```diff
- filter-include-untagged: true
- untagged-only: false
+ tag-selection: both
```
or
```diff
- filter-include-untagged: true
- untagged-only: true
+ tag-selection: untagged
```
- The `cut-off` input no longer accepts human-readable datetimes. Instead, it accepts the inputs listed [here](https://togithub.com/tailhook/humantime). For example:
```diff
- cut-off: two hours and 5 minutes ago UTC+2
+ cut-off: 2h 5m
```
or
```diff
- cut-off: One week ago UTC
+ cut-off: 1w
```
There is no longer timezone support built-into this option. All durations are relative to the current time, UTC.
- The `keep-at-least` argument was renamed `keep-n-most-recent` to make clearer what it does
```diff
- keep-at-least: 5
+ keep-n-most-recent: 5
```
### [`v2.2.1`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.2.1)
[Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.2.0...v2.2.1)
#### What's Changed
- fix: default token-type by [@ChandlerFerry](https://togithub.com/ChandlerFerry) in [https://github.com/snok/container-retention-policy/pull/71](https://togithub.com/snok/container-retention-policy/pull/71)
#### New Contributors
- [@ChandlerFerry](https://togithub.com/ChandlerFerry) made their first contribution in [https://github.com/snok/container-retention-policy/pull/71](https://togithub.com/snok/container-retention-policy/pull/71)
**Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.2.1
### [`v2.2.0`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.2.0)
[Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.1.3...v2.2.0)
#### What's Changed
This new version of the action introduces a `token-type` input variable, which enables the use of `GITHUB_TOKEN` instead of a personal access token - by [@Injabie3](https://togithub.com/Injabie3) in [https://github.com/snok/container-retention-policy/pull/70](https://togithub.com/snok/container-retention-policy/pull/70)
#### New Contributors
- [@Injabie3](https://togithub.com/Injabie3) made their first contribution in [https://github.com/snok/container-retention-policy/pull/70](https://togithub.com/snok/container-retention-policy/pull/70)
**Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.2.0
### [`v2.1.3`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.1.3)
[Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.1.2...v2.1.3)
#### What's Changed
- docs: cron schedule and comment in the example don't match by [@ccatterina](https://togithub.com/ccatterina) in [https://github.com/snok/container-retention-policy/pull/69](https://togithub.com/snok/container-retention-policy/pull/69)
- Make behaviour of `keep_at_least` parameter predictable by [@yma-het](https://togithub.com/yma-het) in [https://github.com/snok/container-retention-policy/pull/68](https://togithub.com/snok/container-retention-policy/pull/68)
#### New Contributors
- [@ccatterina](https://togithub.com/ccatterina) made their first contribution in [https://github.com/snok/container-retention-policy/pull/69](https://togithub.com/snok/container-retention-policy/pull/69)
- [@yma-het](https://togithub.com/yma-het) made their first contribution in [https://github.com/snok/container-retention-policy/pull/68](https://togithub.com/snok/container-retention-policy/pull/68)
**Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.1.3
### [`v2.1.2`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.1.2)
[Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.1.1...v2.1.2)
#### What's Changed
- Fix unhandled exception raised at runtime: 'x-ratelimit-remaining' by [@den-is](https://togithub.com/den-is) in [https://github.com/snok/container-retention-policy/pull/58](https://togithub.com/snok/container-retention-policy/pull/58)
#### New Contributors
- [@den-is](https://togithub.com/den-is) made their first contribution in [https://github.com/snok/container-retention-policy/pull/58](https://togithub.com/snok/container-retention-policy/pull/58)
**Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.1.2
### [`v2.1.1`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.1.1)
[Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.1.0...v2.1.1)
#### What's Changed
- Fix dry-run with filter by [@chris-schra](https://togithub.com/chris-schra) in [https://github.com/snok/container-retention-policy/pull/65](https://togithub.com/snok/container-retention-policy/pull/65)
#### New Contributors
- [@chris-schra](https://togithub.com/chris-schra) made their first contribution in [https://github.com/snok/container-retention-policy/pull/65](https://togithub.com/snok/container-retention-policy/pull/65)
**Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.1.1
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR contains the following updates:
v2.1.0->v3.0.0Release Notes
snok/container-retention-policy (snok/container-retention-policy)
### [`v3.0.0`](https://togithub.com/snok/container-retention-policy/releases/tag/v3.0.0) [Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.2.1...v3.0.0) ##### v3.0.0 > Disclaimer: This release breaks the API of the action to a large degree. It might be wise to run the action with `dry-run: true` after upgrading. This release is a complete rewrite of the action, tackling most if not all open issues in the issue tracker. Some of the highlights include: - Simplifying and consolidating the inputs of the action - Improving the runtime performance, and the initialization time of the action in CI - Support for multi-platform packages - Support for new token types (`secrets.GITHUB_TOKEN` and Github app tokens) - Much better handling of GitHub API rate limits 💥 There are a lot of breaking changes, so we've included a migration guide at the bottom of this post, to make things a bit simpler. Since the release introduces a few thousand lines of code, we expect there may be a few things left to iron out. If you run into any problems, please share them in the [v3 release issue](https://togithub.com/snok/container-retention-policy/issues/84). *** In addition to what's mentioned above, other **new features and changes** include: - Significant effort has been spent on improving the logging, to give better insights into what exactly is happening - Updated license from `BSD-3` to `MIT`. - The available syntax for `image-names` and `image-tags` previously allowed wildcards (using the `*` character). We now also allow the `?` character to express a single-character wildcard. For example, the pattern `ca?` will match `car` and `cat`. See the [wildmatch docs](https://togithub.com/becheran/wildmatch) for details. In addition to changing the inputs of the action (more details below), there are a few other **breaking changes**: - We'll no longer maintain mutable major and minor version tags for the action. There will be no `v3` target for the action, just `v3.0.0` and other exact versions. Mutable major version tags are generally hard to maintain and not much safer than tracking the main branch, so more precise tag tracking should reduce the likelihood of broken runs going forward. Paired with [dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot), upgrading should not be much harder than it has been. - The [`needs-assistance` output](https://togithub.com/snok/container-retention-policy/tree/575226aa6cf28ee190c6611e8cc20d545264f443?tab=readme-ov-file#needs-github-assistance) was deleted And in terms of **performance improvements**: - The action has been rewritten from a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) to a [container action](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action), and the total size of the new image is < 10Mi. - The action would previously take ~30 seconds to initialize and would require a Python runtime. The action now starts in less than a second, and runs as a standalone binary. - The runtime of the action has been reduced, and assuming we need to delete less than 180 package versions, the action completes in, at most, a few seconds. See [this example of a recent run](https://togithub.com/snok/container-retention-policy/actions/runs/9652338073/job/26622259747). When we have to delete more than 180 package versions, there's a minute of waiting for every 180 new package versions, as a consequence of GitHub's secondary API rate limits. See the new README for details. ##### Migration guide - The `account-type` and `org-name` inputs have been replaced with `account`, which should be set to the literal string "user" if you previously used `account-type: personal` and to the organization name otherwise: ```diff - account-type: personal + account: user ``` or ```diff - account-type: organization - org-name: acme + account: acme ``` - The `filter-tags` key has been renamed to `image-tags` ```diff - filter-tags: *-prod + image-tags: "*-prod" ``` - The `token-type` input has been removed. If you previously used `token-type: github-token`, then you can now instead pass the secret value to `token` and have the type of token be auto-detected: ```diff - token-type: github-token + token: ${{ secrets.GITHUB_TOKEN }} ``` In other words, we've consolidated `token-type` and `token` into a single arg. - The `skip-tags` input has been removed. If you previously used `skip-tags: latest`, you should now specify a negative glob pattern in `image-tags`. ```diff - filter-tags: l* - skip-tags: latest + image-tags: "l* !latest" ``` In other words, we've consolidated the two arguments, by adding support for the `!` operator, which means "not". - The `filter-include-untagged` and `untagged-only` inputs were removed. `filter-include-untagged` previously enabled you to opt-out of deleting untagged images, while `untagged-only` would allow you to opt-out of deleting tagged images. This was a bit confusing, even for me. To make things simpler, these have been collapsed into one argument, called `tag-selection` which accepts the string values `tagged`, `untagged`, or `both`. ```diff - filter-include-untagged: true - untagged-only: false + tag-selection: both ``` or ```diff - filter-include-untagged: true - untagged-only: true + tag-selection: untagged ``` - The `cut-off` input no longer accepts human-readable datetimes. Instead, it accepts the inputs listed [here](https://togithub.com/tailhook/humantime). For example: ```diff - cut-off: two hours and 5 minutes ago UTC+2 + cut-off: 2h 5m ``` or ```diff - cut-off: One week ago UTC + cut-off: 1w ``` There is no longer timezone support built-into this option. All durations are relative to the current time, UTC. - The `keep-at-least` argument was renamed `keep-n-most-recent` to make clearer what it does ```diff - keep-at-least: 5 + keep-n-most-recent: 5 ``` ### [`v2.2.1`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.2.1) [Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.2.0...v2.2.1) #### What's Changed - fix: default token-type by [@ChandlerFerry](https://togithub.com/ChandlerFerry) in [https://github.com/snok/container-retention-policy/pull/71](https://togithub.com/snok/container-retention-policy/pull/71) #### New Contributors - [@ChandlerFerry](https://togithub.com/ChandlerFerry) made their first contribution in [https://github.com/snok/container-retention-policy/pull/71](https://togithub.com/snok/container-retention-policy/pull/71) **Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.2.1 ### [`v2.2.0`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.2.0) [Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.1.3...v2.2.0) #### What's Changed This new version of the action introduces a `token-type` input variable, which enables the use of `GITHUB_TOKEN` instead of a personal access token - by [@Injabie3](https://togithub.com/Injabie3) in [https://github.com/snok/container-retention-policy/pull/70](https://togithub.com/snok/container-retention-policy/pull/70) #### New Contributors - [@Injabie3](https://togithub.com/Injabie3) made their first contribution in [https://github.com/snok/container-retention-policy/pull/70](https://togithub.com/snok/container-retention-policy/pull/70) **Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.2.0 ### [`v2.1.3`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.1.3) [Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.1.2...v2.1.3) #### What's Changed - docs: cron schedule and comment in the example don't match by [@ccatterina](https://togithub.com/ccatterina) in [https://github.com/snok/container-retention-policy/pull/69](https://togithub.com/snok/container-retention-policy/pull/69) - Make behaviour of `keep_at_least` parameter predictable by [@yma-het](https://togithub.com/yma-het) in [https://github.com/snok/container-retention-policy/pull/68](https://togithub.com/snok/container-retention-policy/pull/68) #### New Contributors - [@ccatterina](https://togithub.com/ccatterina) made their first contribution in [https://github.com/snok/container-retention-policy/pull/69](https://togithub.com/snok/container-retention-policy/pull/69) - [@yma-het](https://togithub.com/yma-het) made their first contribution in [https://github.com/snok/container-retention-policy/pull/68](https://togithub.com/snok/container-retention-policy/pull/68) **Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.1.3 ### [`v2.1.2`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.1.2) [Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.1.1...v2.1.2) #### What's Changed - Fix unhandled exception raised at runtime: 'x-ratelimit-remaining' by [@den-is](https://togithub.com/den-is) in [https://github.com/snok/container-retention-policy/pull/58](https://togithub.com/snok/container-retention-policy/pull/58) #### New Contributors - [@den-is](https://togithub.com/den-is) made their first contribution in [https://github.com/snok/container-retention-policy/pull/58](https://togithub.com/snok/container-retention-policy/pull/58) **Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.1.2 ### [`v2.1.1`](https://togithub.com/snok/container-retention-policy/releases/tag/v2.1.1) [Compare Source](https://togithub.com/snok/container-retention-policy/compare/v2.1.0...v2.1.1) #### What's Changed - Fix dry-run with filter by [@chris-schra](https://togithub.com/chris-schra) in [https://github.com/snok/container-retention-policy/pull/65](https://togithub.com/snok/container-retention-policy/pull/65) #### New Contributors - [@chris-schra](https://togithub.com/chris-schra) made their first contribution in [https://github.com/snok/container-retention-policy/pull/65](https://togithub.com/snok/container-retention-policy/pull/65) **Full Changelog**: https://github.com/snok/container-retention-policy/compare/v2...v2.1.1Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.