From caada232d741e57a2e90f25df14249907c1d5c66 Mon Sep 17 00:00:00 2001 From: Injabie3 Date: Mon, 13 Nov 2023 11:52:37 -0800 Subject: [PATCH] docs: Move `token-type` closer to `token` This commit moves the `token-type` info within README.md closer to `token`. It also adds a small snippet to token regarding the use of GITHUB_TOKEN. --- README.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 281bea5..88c4771 100644 --- a/README.md +++ b/README.md @@ -212,6 +212,22 @@ with access to the container registry. Specifically, you need to grant it the fo - `read:packages`, and - `delete:packages` +You can also pass in `${{ secrets.GITHUB_TOKEN }}`; however, please see `token-type` +for more details. + +## token-type + +* **Required**: `No` +* **Default**: `pat` +* **Example:**: `token: github-token` +* **Valid choices**: `github-token` or `pat` + +The type of token being passed into `token`, which is used to authenticate to Github. + +Setting this to `github-token` is useful for pruning images from a workflow that lives +in the same repository; however, the `image-names` parameter **MUST** be set to a single +image, and that image **MUST** match the repository's package name. + ## keep-at-least * **Required**: `No` @@ -263,19 +279,6 @@ Whether to consider untagged images for deletion. Prints output showing imaages which would be deleted but does not actually delete any images. -## token-type - -* **Required**: `No` -* **Example:**: `token: github-token` -* **Default**: `pat` -* **Valid choices**: `github-token` or `pat` - -The type of token being passed into `token`, which is used to authenticate to Github. - -Setting this to `github-token` is useful for pruning images from a workflow that lives -in the same repository; however, the `image-names` parameter **MUST** be set to a single -image, and that image **MUST** match the repository's package name. - # Outputs ## deleted