-
Notifications
You must be signed in to change notification settings - Fork 1k
Properly document the archive input.
#781
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -142,6 +142,16 @@ You are welcome to still raise bugs in this repo. | |
| # enabled this to avoid uploading sensitive information. | ||
| # Optional. Default is 'false' | ||
| 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. | ||
desrosj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| # 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. | ||
desrosj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| # The name of the file is used as the artifact name (the 'name' input is ignored). | ||
| # Optional. Default is 'true' | ||
| archive: | ||
|
Comment on lines
+145
to
+153
|
||
| ``` | ||
|
|
||
| ### 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. | ||
|
|
||
| ### 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. | ||
desrosj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### 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. | ||
|
|
@@ -478,7 +501,9 @@ You may also be limited by Artifacts if you have exceeded your shared storage qu | |
|
|
||
| ### 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. | ||
desrosj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Permission Loss | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.