Skip to content

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.

Sign up for GitHub

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

Closed
desrosj wants to merge 2 commits into from
+25 −1
Closed

Properly document the archive input. #781

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b79419b
Properly document the `archive` input.
desrosj Mar 12, 2026
8e8bf8b
Apply suggestions from code review
desrosj Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,15 @@ 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.
# 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:
Comment on lines +145 to +153
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new archive input is described inside the Inputs example that still shows uses: actions/upload-artifact@v4 earlier in the snippet. Since the README also states this behavior is "As of v7", this is inconsistent and may mislead users of v4. Please either update the example version to @v7 (and/or update other examples), or explicitly note here that archive is only supported in v7+.

Copilot uses AI. Check for mistakes.
```

### Outputs
Expand Down Expand Up @@ -216,6 +225,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 if the specified glob patterns match multiple files.

### 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.
Expand Down Expand Up @@ -478,7 +500,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.

### Permission Loss

Expand Down