diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 08b297a..2f58fc9 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -4,7 +4,7 @@ on: # rebuild any PRs and main branch changes pull_request: push: branches: - - master + - main - 'releases/*' jobs: diff --git a/README.md b/README.md index 5a4e23e..5ea1fb9 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Delete Package Versions -This action deletes versions of a package from [GitHub Packages](https://github.com/features/packages). +This action deletes versions of a package from [GitHub Packages](https://github.com/features/packages). ### What It Can Do * Delete a single version * Delete multiple versions -* Delete specific version(s) +* Delete specific version(s) * Delete oldest version(s) * Delete version(s) of a package that is hosted in the same repo that is executing the workflow * Delete version(s) of a package that is hosted in a different repo than the one executing the workflow @@ -19,7 +19,7 @@ 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. @@ -77,7 +77,7 @@ __Example__ To delete a specific version of a package that is hosted in a different repo than the one executing the workflow the __package-version-ids__, and __token__ inputs are required. -Package version ids can be retrieved via the [GitHub GraphQL API][api]. +Package version ids can be retrieved via the [GitHub GraphQL API][api]. The [token][token] only needs the delete packages scope. It is recommended [to store the token as a secret][secret]. In this example the [token][token] was stored as a secret named __GITHUB_PAT__. @@ -94,7 +94,7 @@ __Example__ ### Delete multiple specific versions of a package hosted in the same repo as the workflow -To delete multiple specifc versions of a package that is hosted in the same repo that is executing the workflow the __package-version-ids__ input is required. +To delete multiple specifc versions of a package that is hosted in the same repo that is executing the workflow the __package-version-ids__ input is required. The __package-version-ids__ input should be a comma separated string of package version ids. Package version ids can be retrieved via the [GitHub GraphQL API][api]. @@ -110,7 +110,7 @@ __Example__ ### Delete multiple specific versions of a package hosted in a different repo than the workflow -To delete multiple specifc versions of a package that is hosted in a different repo than the one executing the workflow the __package-version-ids__, and __token__ inputs are required. +To delete multiple specifc versions of a package that is hosted in a different repo than the one executing the workflow the __package-version-ids__, and __token__ inputs are required. The __package-version-ids__ input should be a comma separated string of package version ids. Package version ids can be retrieved via the [GitHub GraphQL API][api]. @@ -191,7 +191,7 @@ Delete the oldest 3 version of a package hosted in a different repo than the one - uses: actions/delete-package-versions@v1 with: owner: 'github' - repo: 'packages' + repo: 'packages' package-name: 'test-package' num-old-versions-to-delete: 3 token: ${{ secrets.GITHUB_PAT }} @@ -199,9 +199,8 @@ Delete the oldest 3 version of a package hosted in a different repo than the one # License -The scripts and documentation in this project are released under the [MIT License](https://github.com/actions/delete-package-versions/blob/master/LICENSE) +The scripts and documentation in this project are released under the [MIT License](https://github.com/actions/delete-package-versions/blob/main/LICENSE) [api]: https://developer.github.com/v4/previews/#github-packages [token]: https://help.github.com/en/packages/publishing-and-managing-packages/about-github-packages#about-tokens [secret]: https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets -