actions/upload-artifact
2
0
Fork 0
mirror of https://github.com/actions/upload-artifact.git synced 2025-04-02 01:36:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge c11cddaf41 into ea165f8d65

Browse source
This commit is contained in:
Josh Soref 2025-03-19 21:53:24 +01:00 • committed by GitHub
commit 9b94dc4183
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -87,19 +87,21 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
# Available Options: # Available Options:
# warn: Output a warning but do not fail the action # warn: Output a warning but do not fail the action
# error: Fail the action with an error message # error: Fail the action with an error message
# ignore: Do not output any warnings or errors, the action does not fail # ignore: Do not output any warnings or errors, does not fail the action
# Optional. Default is 'warn' # Optional. Default is 'warn'
if-no-files-found: if-no-files-found:
# Duration after which artifact will expire in days. 0 means using default retention. # Duration after which artifact will expire in days.
# Minimum 1 day. # 0 means use default retention.
# Maximum 90 days unless changed from the repository settings page. # 1 is the shortest retention.
# Maximum is based on repository settings (the default is 90 days).
# Optional. Defaults to repository settings. # Optional. Defaults to repository settings.
retention-days: retention-days:
# The level of compression for Zlib to be applied to the artifact archive. # The level of compression for Zlib to be applied to the artifact archive.
# The value can range from 0 to 9. # The value can range from 0 to 9.
# For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads. # For large files that are not easily compressed, a value of 0 is recommended for
# significantly faster uploads.
# Optional. Default is '6' # Optional. Default is '6'
compression-level: compression-level:
@ -109,9 +111,9 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
# Optional. Default is 'false' # Optional. Default is 'false'
overwrite: overwrite:
# Whether to include hidden files in the provided path in the artifact # Whether to include hidden files in the provided path in the artifact.
# The file contents of any hidden files in the path should be validated before # The file contents of any hidden files in the path should be validated before
# enabled this to avoid uploading sensitive information. # enabling this to avoid uploading sensitive information.
# Optional. Default is 'false' # Optional. Default is 'false'
include-hidden-files: include-hidden-files:
``` ```
@ -120,8 +122,8 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
| Name | Description | Example | | Name | Description | Example |
| - | - | - | | - | - | - |
| `artifact-id` | GitHub ID of an Artifact, can be used by the REST API | `1234` | | `artifact-id` | GitHub ID of the Artifact, can be used by the REST API | `1234` |
| `artifact-url` | URL to download an Artifact. Can be used in many scenarios such as linking to artifacts in issues or pull requests. Users must be logged-in in order for this URL to work. This URL is valid as long as the artifact has not expired or the artifact, run or repository have not been deleted | `https://github.com/example-org/example-repo/actions/runs/1/artifacts/1234` | | `artifact-url` | URL to download the Artifact. Can be used in many scenarios such as linking to artifacts in issues or pull requests. Users must be logged-in in order for this URL to work. This URL is valid as long as the artifact has not expired and the artifact, run, and repository have not been deleted. | `https://github.com/example-org/example-repo/actions/runs/1/artifacts/1234` |
| `artifact-digest` | SHA-256 digest of an Artifact | 0fde654d4c6e659b45783a725dc92f1bfb0baa6c2de64b34e814dc206ff4aaaf | | `artifact-digest` | SHA-256 digest of an Artifact | 0fde654d4c6e659b45783a725dc92f1bfb0baa6c2de64b34e814dc206ff4aaaf |
## Examples ## Examples
@ -450,7 +452,7 @@ You may also be limited by Artifacts if you have exceeded your shared storage qu
### Zip archives ### Zip archives
When an Artifact is uploaded, all the files are assembled into an immutable Zip archive. There is currently no way to download artifacts in a format other than a Zip or to download individual artifact contents. When an Artifact is uploaded, all the files are assembled into an immutable Zip archive. There is currently no way to download artifacts in a format other than Zip or to download individual artifact contents.
### Permission Loss ### Permission Loss
@ -475,6 +477,6 @@ At the bottom of the workflow summary page, there is a dedicated section for art
<img src="https://user-images.githubusercontent.com/16109154/103645952-223c6880-4f59-11eb-8268-8dca6937b5f9.png" width="700" height="300"> <img src="https://user-images.githubusercontent.com/16109154/103645952-223c6880-4f59-11eb-8268-8dca6937b5f9.png" width="700" height="300">
There is a trashcan icon that can be used to delete the artifact. This icon will only appear for users who have write permissions to the repository. For users who have write permissions to the repository, there is a trashcan icon that can be used to delete the artifact.
The size of the artifact is denoted in bytes. The displayed artifact size denotes the size of the zip that `upload-artifact` creates during upload. The size of the artifact is denoted in bytes. The displayed artifact size denotes the size of the zip that `upload-artifact` creates during upload.