diff --git a/README.md b/README.md index 87a4809..4283b0c 100644 --- a/README.md +++ b/README.md @@ -19,32 +19,32 @@ This action deletes versions of a package from [GitHub Packages](https://github. # Can be a single package version id, or a comma separated list of package version ids. # Defaults to an empty string. package-version-ids: + + # Owner of the repo hosting the package. + # Defaults to the owner of the repo executing the workflow. + # Required if deleting a version from a package hosted in a different repo than the one executing the workflow. + owner: + + # Repo hosting the package. + # Defaults to the repo executing the workflow. + # Required if deleting a version from a package hosted in a different repo than the one executing the workflow. + repo: - # Owner of the repo hosting the package. - # Defaults to the owner of the repo executing the workflow. - # Required if deleting a version from a package hosted in a different repo than the one executing the workflow. - owner: '' + # Name of the package. + # Defaults to an empty string. + # Required if `package-version-ids` input is not given. + package-name: - # Repo hosting the package. - # Defaults to the repo executing the workflow. - # Required if deleting a version from a package hosted in a different repo than the one executing the workflow. - repo: '' + # The number of old versions to delete starting from the oldest version. + # Defaults to 1. + num-old-versions-to-delete: - # Name of the package. - # Defaults to an empty string. - # Required if `package-version-ids` input is not given. - package-name: '' - - # The number of old versions to delete starting from the oldest version. - # Defaults to 1. - num-old-versions-to-delete: '' - - # The token used to authenticate with GitHub Packages. - # Defaults to github.token. - # Required if deleting a version from a package hosted in a different repo than the one executing the workflow. - # If `package-version-ids` is given the token only needs the delete packages scope. - # If `package-version-ids` is not given the token needs the delete packages scope and the read packages scope - token: '' + # The token used to authenticate with GitHub Packages. + # Defaults to github.token. + # Required if deleting a version from a package hosted in a different repo than the one executing the workflow. + # If `package-version-ids` is given the token only needs the delete packages scope. + # If `package-version-ids` is not given the token needs the delete packages scope and the read packages scope + token: '' ```