actions/upload-artifact@v7
Upload a build artifact that can be used by subsequent workflow steps
At a glance
- Latest major
v7- Repository
- actions/upload-artifact
- Inputs
- 8 (1 required)
- Outputs
- 3
- Runs using
node24- License
- MIT
- Last checked
Inputs and outputs come straight from the action's official action.yml. See our editorial standards.
Usage
- uses: actions/upload-artifact@v7Inputs
| Name | Required | Default | Description |
|---|---|---|---|
name | No | artifact | Artifact name. If the `archive` input is `false`, the name of the file uploaded will be the artifact name. |
path | Yes | none | A file, directory or wildcard pattern that describes what to upload. |
if-no-files-found | No | warn | The desired behavior if no files are found using the provided path. Available Options: warn: Output a warning but do not fail the action error: Fail the action with an error message ignore: Do not output any warnings or errors, the action does not fail |
retention-days | No | none | Duration after which artifact will expire in days. 0 means using default retention. Minimum 1 day. Maximum 90 days unless changed from the repository settings page. |
compression-level | No | 6 | The level of compression for Zlib to be applied to the artifact archive. The value can range from 0 to 9: - 0: No compression - 1: Best speed - 6: Default compression (same as GNU Gzip) - 9: Best compression Higher levels will result in better compression, but will take longer to complete. For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads. |
overwrite | No | false | If true, an artifact with a matching name will be deleted before a new one is uploaded. If false, the action will fail if an artifact for the given name already exists. Does not fail if the artifact does not exist. |
include-hidden-files | No | false | If true, hidden files will be included in the artifact. If false, hidden files will be excluded from the artifact. |
archive | No | true | If true, the artifact will be archived (zipped) before uploading. If false, the artifact will be uploaded as-is without archiving. When `archive` is `false`, only a single file can be uploaded. The name of the file will be used as the artifact name (ignoring the `name` parameter). |
Outputs
| Name | Description |
|---|---|
artifact-id | A unique identifier for the artifact that was just uploaded. Empty if the artifact upload failed. This ID can be used as input to other APIs to download, delete or get more information about an artifact: https://docs.github.com/en/rest/actions/artifacts |
artifact-url | A download URL for the artifact that was just uploaded. Empty if the artifact upload failed. This download URL only works for requests Authenticated with GitHub. Anonymous downloads will be prompted to first login. If an anonymous download URL is needed than a short time restricted URL can be generated using the download artifact API: https://docs.github.com/en/rest/actions/artifacts#download-an-artifact This URL will be valid for as long as the artifact exists and the workflow run and repositor |
artifact-digest | SHA-256 digest for the artifact that was just uploaded. Empty if the artifact upload failed. |
Read an output with ${{ steps.<step-id>.outputs.<name> }}; the step needs an id.
Examples
Upload build output
Keep a build or test report after the job ends, with a retention limit.
name: Example
on:
push:
branches: [main]
permissions:
contents: read
jobs:
example:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- name: Build
run: mkdir -p dist && echo built > dist/app.txt
- name: Upload a Build Artifact
uses: actions/upload-artifact@v7
with:
name: dist
path: dist/
retention-days: 7
if-no-files-found: errorEach example passed actionlint (syntax, expressions and the inputs it knows for this action). They were not run in a live repository, so replace placeholder values such as names, ARNs and paths with your own.
Something out of date or wrong? Report it on our Contact page. This page is rebuilt from the action's repository roughly once a week.