zhuxb711/Artifact Size Based Cleanup
Cleanup artifacts base on the size limit to make sure the storage space is not exhausted.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | The GitHub token used to access the repository. Must grant the token access permission with 'workflow' scope or grant write access to 'action' permission on the GITHUB_TOKEN in the job level. If not provided, will use the default GITHUB_TOKEN. | no | ${{ github.token }} |
| limit | The maximum size of the artifacts in bytes for current repository. Action will make sure the all artifacts size is less than this limit and reserve enough space for new artifacts. Allowed values includes - [1024, 256KB, 512MB, 1.5GB]. If this value is less than or equal to zero, the action will clean up all artifacts. | yes | — |
| fixedReservedSize | Optional. Use a fixed size to reserve the space. If not provided, will use the value of 'artifactPaths' to calculate the size of the artifacts to be uploaded automatically. Allowed values includes - [1024, 256KB, 512MB, 1.5GB]. An exception will be thrown if both 'fixedReservedSize' and 'artifactPaths' are not provided unless 'limit' is less than or equal to zero. | no | — |
| artifactPaths | Optional. The paths of the artifacts to be uploaded, will calculate the size automatically. Supports glob patterns (wildcards) like *, **, ?, [], {}. If not provided, will use the value of 'fixedReservedSize'. An exception will be thrown if both 'fixedReservedSize' and 'artifactPaths' are not provided. | no | — |
| simulateCompressionLevel | Optional. The compression level of the artifacts to be uploaded. Should be the same value as you specific in the upload artifacts action. Will use this value to simulate the compression and calculate the actual size of the artifact after compression. If not provided, will use the default value of 6. | no | 6 |
| failOnError | Indicates whether the action should fail once encountering any errors. | no | true |
| removeDirection | The direction to remove the artifacts. Allowed values includes - [oldest, newest]. If set to 'oldest', the action will remove the oldest artifacts first. If set to 'newest', the action will remove the newest artifacts first. | no | oldest |
Outputs
no outputs