Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
rohanmars committed Jun 29, 2024
1 parent 83b6833 commit 407eee1
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ It includes the following features:

## Setup

### Do a dry-run

Test the cleanup action first by setting the "dry-run: true" option on the
action and then reviewing the workflow log. This mode will simulate the cleanup
action but will not delete any images/packages. This is especially important
when using a wild card syntax to select images.

### Token Permissions

To allow the injected GITHUB_TOKEN to have access to delete the images/packages
Expand Down Expand Up @@ -56,10 +63,10 @@ ensure it's permissions have been setup correctly, either by:
| repository | no | repository name | The repository name |
| package | no | repository name | The package name |
If the tags, keep_n_untagged or keep_n_tagged options are not set then all
If the tags, keep-n-untagged or keep-n-tagged options are not set then all
untagged images will be deleted.
The keep_n_untagged and keep_n_tagged options can not be set at the same time.
The keep-n-untagged and keep-n-tagged options can not be set at the same time.
## Main Execution Modes
Expand Down Expand Up @@ -232,12 +239,6 @@ jobs:
## Notes
### Do a dry-run
Test the cleanup action first by setting the "dry-run: true" option on the
action and then reviewing the workflow log. This mode will simulate the cleanup
action but will not delete any images/packages.
### Package Restoration
GitHub has a package restoration API capability. The package IDs are printed in
Expand Down

0 comments on commit 407eee1

Please sign in to comment.