Update README.md

[dianecloud]

@actions/upload-artifact

Warning

actions/upload-artifact@v3 is scheduled for deprecation on November 30, 2024. Learn more.
Similarly, v1/v2 are scheduled for deprecation on June 30, 2024.
Please update your workflow to use v4 of the artifact actions.
This deprecation will not impact any existing versions of GitHub Enterprise Server being used by customers.

Upload Actions Artifacts from your Workflow Runs. Internally powered by @actions/artifact package.

See also download-artifact.

• @actions/upload-artifact
  • v6 - What's new
  • v4 - What's new
    • Improvements
    • Breaking Changes
  • Usage
    • Inputs
    • Outputs
  • Examples
    • Upload an Individual File
    • Upload an Entire Directory
    • Upload using a Wildcard Pattern
    • Upload using Multiple Paths and Exclusions
    • Altering compressions level (speed v. size)
    • Customization if no files are found
    • (Not) Uploading to the same artifact
    • Environment Variables and Tilde Expansion
    • Retention Period
    • Using Outputs
      • Example output between steps
      • Example output between jobs
    • Overwriting an Artifact
  • Limitations
    • Number of Artifacts
    • Zip archives
    • Permission Loss
  • Where does the upload go?

v6 - What's new

Important

actions/upload-artifact@v6 now runs on Node.js 24 (runs.using: node24) and requires a minimum Actions Runner version of 2.327.1. If you are using self-hosted runners, ensure they are updated before upgrading.

Node.js 24

This release updates the runtime to Node.js 24. v5 had preliminary support for Node.js 24, however this action was by default still running on Node.js 20. Now this action by default will run on Node.js 24.

v4 - What's new

Important

upload-artifact@v4+ is not currently supported on GitHub Enterprise Server (GHES) yet. If you are on GHES, you must use v3 (Node 16) or v3-node20 (Node 20).

The release of upload-artifact@v4 and download-artifact@v4 are major changes to the backend architecture of Artifacts. They have numerous performance and behavioral improvements.

For more information, see the @actions/artifact documentation.

There is also a new sub-action, actions/upload-artifact/merge. For more info, check out that action's README.

Improvements

1. Uploads are significantly faster, upwards of 90% improvement in worst case scenarios.
2. Once uploaded, an Artifact ID is returned and Artifacts are immediately available in the UI and REST API. Previously, you would have to wait for the run to be completed before an ID was available or any APIs could be utilized.
3. The contents of an Artifact are uploaded together into an immutable archive. They cannot be altered by subsequent jobs unless the Artifacts are deleted and recreated (where they will have a new ID). Both of these factors help reduce the possibility of accidentally corrupting Artifact files.
4. The compression level of an Artifact can be manually tweaked for speed or size reduction.

Breaking Changes

1. On self hosted runners, additional firewall rules may be required.