actions/upload-artifact
1
0
Fork 0
mirror of https://code.forgejo.org/actions/upload-artifact.git synced 2026-03-25 09:18:03 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Properly document the archive input.

Browse source
This commit is contained in:
Jonathan Desrosiers 2026-03-12 14:30:45 -04:00
parent bbbca2ddaa
commit b79419bf88
No known key found for this signature in database
GPG key ID: 77A289CE188C0291
1 changed files with 26 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -142,6 +142,16 @@ You are welcome to still raise bugs in this repo.
# enabled this to avoid uploading sensitive information. # enabled this to avoid uploading sensitive information.
# Optional. Default is 'false' # Optional. Default is 'false'
include-hidden-files: include-hidden-files:
# Whether to archive files before uploading.
# When set to 'true', the artifact will be archived (.zip format) before uploading.
# When set to 'false, the artifact will be uploaded as-is without archiving.
# Notes when set to 'false':
# Only individual files can be uploaded without archiving.
# The action will fail when the specified glob patterns resolve to multiple files.
# The name of the file is used as the artifact name (the 'name' input is ignored).
# Optional. Default is 'true'
archive:
``` ```
### Outputs ### Outputs
@ -216,6 +226,19 @@ If multiple paths are provided as input, the least common ancestor of all the se
Relative and absolute file paths are both allowed. Relative paths are rooted against the current working directory. Paths that begin with a wildcard character should be quoted to avoid being interpreted as YAML aliases. Relative and absolute file paths are both allowed. Relative paths are rooted against the current working directory. Paths that begin with a wildcard character should be quoted to avoid being interpreted as YAML aliases.
### Upload without archiving (zipping)
As of `v7`, an artifact can be uploaded without first being compressed into a .zip file.
```yaml
- uses: actions/upload-artifact@v7
with:
path: generated-changelog.md
archive: false
```
This feature only supports uploading a single file. The action will fail when the specified glob patterns matching multiple files.
### Altering compressions level (speed v. size) ### Altering compressions level (speed v. size)
If you are uploading large or easily compressable data to your artifact, you may benefit from tweaking the compression level. By default, the compression level is `6`, the same as GNU Gzip. If you are uploading large or easily compressable data to your artifact, you may benefit from tweaking the compression level. By default, the compression level is `6`, the same as GNU Gzip.
@ -478,7 +501,9 @@ 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 by default. There is currently no way to download individual artifact contents.
The [exception to this rule](#Upload without archiving (zipping)) is when the `archive` input is set to `false`. This prevents files from being compressed prior to uploading, but only single files are supported at this time.
### Permission Loss ### Permission Loss