Skip to content

Latest commit

 

History

History
235 lines (164 loc) · 9.69 KB

README.md

File metadata and controls

235 lines (164 loc) · 9.69 KB
Raw

Delete Package Versions

This action deletes versions of a package from GitHub Packages.

What It Can Do

  • Delete a single version
  • Delete multiple versions
  • Delete specific version(s)
  • Delete oldest version(s)
  • Delete oldest version(s) while ignoring a specific version pattern
  • 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

Usage

- uses: actions/delete-package-versions@v1
  with:
  # Can be a single package version id, or a comma separated list of package version ids.
  # Defaults to an empty string.
  package-version-ids:

  # Regular expression string matching package version names to never delete.
  # This has no effect when explicitly specifying package version ids using package-version-ids.
  # As a result of the match, less than num-old-versions-to-delete may be deleted.
  # Defaults to allowing all packages.
  ignored-version-names:

  # 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:

  # 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 number of old versions to query for to build the list of old versions.
  # Defaults to the value of num-old-versions-to-delete
  search-range:

  # 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:

  # Perform a dry-run: only print out actions to be performed without actually deleting anything.
  # Defaults to false.
  dry-run:

Scenarios

Delete a specific version of a package hosted in the same repo as the workflow

To delete a specific version of a package that is hosted in the same repo as the one executing the workflow the package-version-ids input is required.

Package version ids can be retrieved via the GitHub GraphQL API

Example

- uses: actions/delete-package-versions@v1
  with:
    package-version-ids: 'MDE0OlBhY2thZ2VWZXJzaW9uOTcyMDY3'

Delete a specific version of a package hosted in a different repo than the workflow

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.

The token only needs the delete packages scope. It is recommended to store the token as a secret. In this example the token was stored as a secret named GITHUB_PAT.

Example

- uses: actions/delete-package-versions@v1
  with:
    package-version-ids: 'MDE0OlBhY2thZ2VWZXJzaW9uOTcyMDY3'
    token: ${{ secrets.GITHUB_PAT }}

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.

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.

Example

- uses: actions/delete-package-versions@v1
  with:
    package-version-ids: 'MDE0OlBhY2thZ2VWZXJzaW9uOTcyMDY3, MDE0OlBhY2thZ2VWZXJzaW9uOTcyMzQ5, MDE0OlBhY2thZ2VWZXJzaW9uOTcyMzUw'

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.

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.

The token only needs the delete packages scope. It is recommended to store the token as a secret. In this example the token was stored as a secret named GITHUB_PAT.

Example

- uses: actions/delete-package-versions@v1
  with:
    package-version-ids: 'MDE0OlBhY2thZ2VWZXJzaW9uOTcyMDY3, MDE0OlBhY2thZ2VWZXJzaW9uOTcyMzQ5, MDE0OlBhY2thZ2VWZXJzaW9uOTcyMzUw'
    token: ${{ secrets.GITHUB_PAT }}

Delete oldest version of a package hosted in the same repo as the workflow

To delete the oldest version of a package that is hosted in the same repo that is executing the workflow the package-name input is required.

Example

- uses: actions/delete-package-versions@v1
  with:
    package-name: 'test-package'

Delete oldest version of a package hosted in a different repo than the workflow

To delete the oldest version of a package that is hosted in a different repo than the one executing the workflow the package-name, owner, repo, and token inputs are required.

The token needs the delete packages and read packages scope. It is recommended to store the token as a secret. In this example the token was stored as a secret named GITHUB_PAT.

Example

- uses: actions/delete-package-versions@v1
  with:
    owner: 'github'
    repo: 'packages'
    package-name: 'test-package'
    token: ${{ secrets.GITHUB_PAT }}

Delete oldest x number of versions of a package hosted in the same repo as the workflow

To delete the oldest x number of versions of a package hosted in the same repo that is executing the workflow the package-name, and num-old-versions-to-delete inputs are required.

Example

Delete the oldest 3 version of a package hosted in the same repo as the workflow

- uses: actions/delete-package-versions@v1
  with:
    package-name: 'test-package'
    num-old-versions-to-delete: 3

Delete oldest x number of versions of a package hosted in a different repo than the workflow

To delete the oldest x number of versions of a package hosted in a different repo than the one executing the workflow the package-name, num-old-versions-to-delete, owner, repo, and token inputs are required.

The token needs the delete packages and read packages scope. It is recommended to store the token as a secret. In this example the token was stored as a secret named GITHUB_PAT.

Example

Delete the oldest 3 version of a package hosted in a different repo than the one executing the workflow

- uses: actions/delete-package-versions@v1
  with:
    owner: 'github'
    repo: 'packages'  
    package-name: 'test-package'
    num-old-versions-to-delete: 3
    token: ${{ secrets.GITHUB_PAT }}

Delete oldest x number of versions of a package excluding packages whose name matches a given pattern

To delete the oldest x nubmer of versions of a package, but exclude packages whost name matches a given pattern from being deleted.

- uses: actions/delete-package-versions@v1
  with:
    package-name: 'test-package'
    num-old-versions-to-delete: 3
    ignored-version-names: "docker-base-layer|^\\d+\\.\\d+$"

License

The scripts and documentation in this project are released under the MIT License