Skip to content

Commit

Permalink
docs: Move token-type closer to token
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Injabie3 authored and sondrelg committed Dec 7, 2023
1 parent a13f7f0 commit caada23
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit caada23

Please sign in to comment.