Skip to content

Properly document the archive input.#781

Open
desrosj wants to merge 2 commits intoactions:mainfrom
desrosj:document-archive-input-in-readme
Open

Properly document the archive input.#781
desrosj wants to merge 2 commits intoactions:mainfrom
desrosj:document-archive-input-in-readme

Conversation

@desrosj
Copy link

@desrosj desrosj commented Mar 12, 2026

This updates the README.md file to properly document the archive input added in v7.0.0.

Copilot AI review requested due to automatic review settings March 12, 2026 18:31
@desrosj desrosj requested a review from a team as a code owner March 12, 2026 18:31
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the repository README to document the archive input (introduced in v7) and explain how to upload a single file without pre-zipping it.

Changes:

  • Adds archive to the Inputs section with behavioral notes for archive: false.
  • Adds a new “Upload without archiving (zipping)” section with a YAML example.
  • Updates the “Zip archives” limitation text to describe the default behavior and the archive: false exception.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +146 to +154
# 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:
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.
- Removing stray spaces.
- Correcting local heading link.
- Grammar fix.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants