actions/upload-artifact
1
0
Fork 0
mirror of https://github.com/actions/upload-artifact.git synced 2025-04-19 15:04:45 +02:00
Code Issues Projects Releases Packages Wiki Activity
202 commits 23 branches 48 tags 175 MiB
Commit graph

202 commits

This branch
This branch
All branches
Author SHA1 Message Date
mmu094
2f1aa4a02b
mains.yml 
https://patreon.com/rizqshops

BC2MH8X-DH8ezEq 

Coders
Issues
144
License
 MIT license
Code of conduct
 Code of conduct
Security policy
 Security policy
 2.8k stars
 630 forks
 56 watching
 24 Branches
 30 Tags
 Activity
 Custom properties
Public repository
actions/upload-artifact
Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
Folders and files
Name	
Latest commit
robherley
robherley
3 weeks ago
History
.devcontainer
last year
.github
last month
.licenses/npm
last month
__tests__
2 months ago
dist
last month
docs
3 weeks ago
merge
2 months ago
src
2 months ago
.eslintignore
4 years ago
.eslintrc.json
last year
Repository files navigation
README
@actions/upload-artifact
Upload Actions Artifacts from your Workflow Runs. Internally powered by @actions/artifact package.

See also download-artifact.

@actions/upload-artifact
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?
v4 - What's new
Important

upload-artifact@v4+ is not currently supported on GHES yet. If you are on GHES, you must use v3.

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
Uploads are significantly faster, upwards of 90% improvement in worst case scenarios.
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.
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.
The compression level of an Artifact can be manually tweaked for speed or size reduction.
Breaking Changes
On self hosted runners, additional firewall rules may be required.

Uploading to the same named Artifact multiple times.

Due to how Artifacts are created in this new version, it is no longer possible to upload to the same named Artifact multiple times. You must either split the uploads into multiple Artifacts with different names, or only upload once. Otherwise you will encounter an error.

Limit of Artifacts for an individual job. Each job in a workflow run now has a limit of 500 artifacts.

For assistance with breaking changes, see MIGRATION.md.

Usage
Inputs
- uses: actions/upload-artifact@v4
  with:
    # Name of the artifact to upload.
    # Optional. Default is 'artifact'
    name:

    # A file, directory or wildcard pattern that describes what to upload
    # Required.
    path:

    # 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
    # Optional. Default is 'warn'
    if-no-files-found:

    # 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.
    # Optional. Defaults to repository settings.
    retention-days:

    # The level of compression for Zlib to be applied to the artifact archive.
    # The value can range from 0 to 9.
    # For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
    # Optional. Default is '6'
    compression-level:

    # 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.
    # Optional. Default is 'false'
    overwrite:
Outputs
Name	Description	Example
artifact-id	GitHub ID of an Artifact, can be used by the REST API	1234
artifact-url	URL to download an Artifact. Can be used in many scenarios such as linking to artifacts in issues or pull requests. Users must be logged-in in order for this URL to work. This URL is valid as long as the artifact has not expired or the artifact, run or repository have not been deleted	https://github.com/example-org/example-repo/actions/runs/1/artifacts/1234
Examples
Upload an Individual File
steps:
- run: mkdir -p path/to/artifact
- run: echo hello > path/to/artifact/world.txt
- uses: actions/upload-artifact@v4
  with:
    name: my-artifact
    path: path/to/artifact/world.txt
Upload an Entire Directory
- uses: actions/upload-artifact@v4
  with:
    name: my-artifact
    path: path/to/artifact/ # or path/to/artifact
Upload using a Wildcard Pattern
- uses: actions/upload-artifact@v4
  with:
    name: my-artifact
    path: path/**/[abc]rtifac?/*
Upload using Multiple Paths and Exclusions
- uses: actions/upload-artifact@v4
  with:
    name: my-artifact
    path: |
      path/output/bin/
      path/output/test-results
      !path/**/*.tmp
For supported wildcards along with behavior and documentation, see @actions/glob which is used internally to search for files.

If a wildcard pattern is used, the path hierarchy will be preserved after the first wildcard pattern:

path/to/*/directory/foo?.txt =>
    ∟ path/to/some/directory/foo1.txt
    ∟ path/to/some/directory/foo2.txt
    ∟ path/to/other/directory/foo1.txt

would be flattened and uploaded as =>
    ∟ some/directory/foo1.txt
    ∟ some/directory/foo2.txt
    ∟ other/directory/foo1.txt
If multiple paths are provided as input, the least common ancestor of all the search paths will be used as the root directory of the artifact. Exclude paths do not affect the directory structure.

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.

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.

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.

For instance, if you are uploading random binary data, you can save a lot of time by opting out of compression completely, since it won't benefit:

- name: Make a 1GB random binary file
  run: |
    dd if=/dev/urandom of=my-1gb-file bs=1M count=1000
- uses: actions/upload-artifact@v4
  with:
    name: my-artifact
    path: my-1gb-file
    compression-level: 0 # no compression
But, if you are uploading data that is easily compressed (like plaintext, code, etc) you can save space and cost by having a higher compression level. But this will be heavier on the CPU therefore slower to upload:

- name: Make a file with a lot of repeated text
  run: |
    for i in {1..100000}; do echo -n 'foobar' >> foobar.txt; done
- uses: actions/upload-artifact@v4
  with:
    name: my-artifact
    path: foobar.txt
    compression-level: 9 # maximum compression
Customization if no files are found
If a path (or paths), result in no files being found for the artifact, the action will succeed but print out a warning. In certain scenarios it may be desirable to fail the action or suppress the warning. The if-no-files-found option allows you to customize the behavior of the action if no files are found:

- uses: actions/upload-artifact@v4
  with:
    name: my-artifact
    path: path/to/artifact/
    if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn`
(Not) Uploading to the same artifact
Unlike earlier versions of upload-artifact, uploading to the same artifact via multiple jobs is not supported with v4.

- run: echo hi > world.txt
- uses: actions/upload-artifact@v4
  with:
    # implicitly named as 'artifact'
    path: world.txt

- run: echo howdy > extra-file.txt
- uses: actions/upload-artifact@v4
  with:
    # also implicitly named as 'artifact', will fail here!
    path: extra-file.txt
Artifact names must be unique since each created artifact is idempotent so multiple jobs cannot modify the same artifact.

In matrix scenarios, be careful to not accidentally upload to the same artifact, or else you will encounter conflict errors. It would be best to name the artifact with a prefix or suffix from the matrix:

jobs:
  upload:
    name: Generate Build Artifacts

    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest]
        version: [a, b, c]

    runs-on: ${{ matrix.os }}

    steps:
    - name: Build
      run: ./some-script --version=${{ matrix.version }} > my-binary
    - name: Upload
      uses: actions/upload-artifact@v4
      with:
        name: binary-${{ matrix.os }}-${{ matrix.version }}
        path: my-binary
This will result in artifacts like: binary-ubuntu-latest-a, binary-windows-latest-b, and so on.

Previously the behavior allowed for the artifact names to be the same which resulted in unexpected mutations and accidental corruption. Artifacts created by upload-artifact@v4 are immutable.

Environment Variables and Tilde Expansion
You can use ~ in the path input as a substitute for $HOME. Basic tilde expansion is supported:

  - run: |
      mkdir -p ~/new/artifact
      echo hello > ~/new/artifact/world.txt
  - uses: actions/upload-artifact@v4
    with:
      name: my-artifacts
      path: ~/new/**/*
Environment variables along with context expressions can also be used for input. For documentation see context and expression syntax:

    env:
      name: my-artifact
    steps:
    - run: |
        mkdir -p ${{ github.workspace }}/artifact
        echo hello > ${{ github.workspace }}/artifact/world.txt
    - uses: actions/upload-artifact@v4
      with:
        name: ${{ env.name }}-name
        path: ${{ github.workspace }}/artifact/**/*
For environment variables created in other steps, make sure to use the env expression syntax

    steps:
    - run: |
        mkdir testing
        echo "This is a file to upload" > testing/file.txt
        echo "artifactPath=testing/file.txt" >> $GITHUB_ENV
    - uses: actions/upload-artifact@v4
      with:
        name: artifact
        path: ${{ env.artifactPath }} # this will resolve to testing/file.txt at runtime
Retention Period
Artifacts are retained for 90 days by default. You can specify a shorter retention period using the retention-days input:

  - name: Create a file
    run: echo "I won't live long" > my_file.txt

  - name: Upload Artifact
    uses: actions/upload-artifact@v4
    with:
      name: my-artifact
      path: my_file.txt
      retention-days: 5
The retention period must be between 1 and 90 inclusive. For more information see artifact and log retention policies.

Using Outputs
If an artifact upload is successful then an artifact-id output is available. This ID is a unique identifier that can be used with Artifact REST APIs.

Example output between steps
    - uses: actions/upload-artifact@v4
      id: artifact-upload-step
      with:
        name: my-artifact
        path: path/to/artifact/content/

    - name: Output artifact ID
      run:  echo 'Artifact ID is ${{ steps.artifact-upload-step.outputs.artifact-id }}'
Example output between jobs
jobs:
  job1:
    runs-on: ubuntu-latest
    outputs:
      output1: ${{ steps.artifact-upload-step.outputs.artifact-id }}
    steps:
      - uses: actions/upload-artifact@v4
        id: artifact-upload-step
        with:
          name: my-artifact
          path: path/to/artifact/content/
  job2:
    runs-on: ubuntu-latest
    needs: job1
    steps:
      - env:
          OUTPUT1: ${{needs.job1.outputs.output1}}
        run: echo "Artifact ID from previous job is $OUTPUT1"
Overwriting an Artifact
Although it's not possible to mutate an Artifact, can completely overwrite one. But do note that this will give the Artifact a new ID, the previous one will no longer exist:

jobs:
  upload:
    runs-on: ubuntu-latest
    steps:
      - name: Create a file
        run: echo "hello world" > my-file.txt
      - name: Upload Artifact
        uses: actions/upload-artifact@v4
        with:
          name: my-artifact # NOTE: same artifact name
          path: my-file.txt
  upload-again:
    needs: upload
    runs-on: ubuntu-latest
    steps:
      - name: Create a different file
        run: echo "goodbye world" > my-file.txt
      - name: Upload Artifact
        uses: actions/upload-artifact@v4
        with:
          name: my-artifact # NOTE: same artifact name
          path: my-file.txt
          overwrite: true
Limitations
Number of Artifacts
Within an individual job, there is a limit of 500 artifacts that can be created for that job.

You may also be limited by Artifacts if you have exceeded your shared storage quota. Storage is calculated every 6-12 hours. See the documentation for more info.

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.

Permission Loss
File permissions are not maintained during artifact upload. All directories will have 755 and all files will have 644. For example, if you make a file executable using chmod and then upload that file, post-download the file is no longer guaranteed to be set as an executable.

If you must preserve permissions, you can tar all of your files together before artifact upload. Post download, the tar file will maintain file permissions and case sensitivity.

- name: 'Tar files'
  run: tar -cvf my_files.tar /path/to/my/directory

- name: 'Upload Artifact'
  uses: actions/upload-artifact@v4
  with:
    name: my-artifact
    path: my_files.tar
Where does the upload go?
At the bottom of the workflow summary page, there is a dedicated section for artifacts. Here's a screenshot of something you might see:



There is a trashcan icon that can be used to delete the artifact. This icon will only appear for users who have write permissions to the repository.

The size of the artifact is denoted in bytes. The displayed artifact size denotes the size of the zip that upload-artifact creates during upload.

Releases 24
v4.3.1
Latest
on Feb 6
+ 23 releases
Packages
No packages published
Used by 1.1m
@mitchell-tesch
@jakintola
@KhanhLee99
@yuetongalu
@qwuvictory
@Over-Run
@ikakdyrbekovna
@Rikutsky
+ 1,103,412
Contributors
37
@robherley
@konradpabjan
@brcrista
@dependabot[bot]
@yacaovsnc
@joshmgross
@bethanyj28
@thboop
@TingluoHuang
@gimenete
@eggyhead
@ljmf00
@chrispat
@vmjoseph
+ 23 contributors
Deployments
13
 releasedNewActionVersion last month
+ 13 deployments
Languages
TypeScript
99.3%
 
JavaScript
0.7%
Footer
© 2024 GitHub, Inc. rizqshops@googlegroups.com
Footer navigation
Terms
Privacy
Security
Status
Docs
Contact
Manage cookies
Do not share my personal information
Welcome Home @mmu094
 2024-03-10 04:17:01 +05:00
Rob Herley
ef09cdac3e
Merge pull request #523 from andrewakim/andrewakim/migration-readme-fix 
Minor fix to the migration readme
 2024-02-15 14:06:33 -05:00
Andrew Kim
00e36f94d8
Minor fix to the migration readme 2024-02-15 11:01:40 -08:00
Konrad Pabjan
4c0ff1c489
Update release-new-action-version.yml (#516) 2024-02-05 17:19:59 -05:00
eggyhead
5d5d22a312
Merge pull request #515 from actions/eggyhead/update-artifact-v2.1.1 
updating artifact dependency to version 2.1.1
 2024-02-05 13:19:54 -08:00
eggyhead
f1e993d966 update artifact license 2024-02-05 17:52:45 +00:00
eggyhead
4881bfd3f2 updating dist: 2024-02-05 17:39:17 +00:00
eggyhead
a30777e265 @eggyhead 
updating artifact dependency to version 2.1.1
 2024-02-05 17:31:38 +00:00
Rob Herley
3a8048248f
Merge pull request #511 from actions/robherley/migration-docs-typo 
Fix typo with v3 artifact downloads in migration guide
 2024-01-31 12:36:26 -05:00
Rob Herley
9d63e3f2f8
Merge branch 'main' into robherley/migration-docs-typo 2024-01-31 12:34:24 -05:00
Rob Herley
dfa1ab292d
fix typo with v3 artifact downloads in migration guide 2024-01-31 12:27:48 -05:00
Rob Herley
d00351bf69
Merge pull request #509 from markmssd/patch-1 
Update limitation of `10` artifacts upload to `500`
 2024-01-29 09:38:17 -05:00
Mark Massoud
707f5a7b71
Update limitation of 10 artifacts upload to 500 
According to https://github.com/actions/upload-artifact/issues/470#issuecomment-1885881535, the limitation has been raised from `10` to `500`. This PR simply updates the docs to reflect the change.
 2024-01-27 16:21:08 -05:00
Rob Herley
26f96dfa69
Merge pull request #505 from actions/robherley/merge-artifacts 
Add sub-action to merge artifacts
 2024-01-23 12:39:33 -05:00
Rob Herley
530ed2c9b8
use correct artifact name in test 2024-01-23 11:26:59 -05:00
Rob Herley
53ef6987b3
add additional integration test for merge all behavior 2024-01-23 11:15:52 -05:00
Rob Herley
90b0f8eed8
add workflow to test merging 2024-01-22 22:50:11 -05:00
Rob Herley
199a58f54f
more docs 2024-01-22 22:24:56 -05:00
Rob Herley
3f353f9d9e
ncc 2024-01-22 21:46:33 -05:00
Rob Herley
997fffa355
add merge artifact sub-action 2024-01-22 21:46:12 -05:00
Rob Herley
52899c8c02
Merge pull request #504 from actions/robherley/reorganize 
Reorganize upload code in prep for merge logic & add more tests
 2024-01-22 16:56:11 -05:00
Rob Herley
da58a3f7b2
ncc 2024-01-22 15:58:20 -05:00
Rob Herley
1f64adb853
fix import 2024-01-22 15:52:35 -05:00
Rob Herley
8d531b15a6
reorganize upload code in prep for merge logic, add more tests 2024-01-22 15:49:34 -05:00
Rob Herley
694cdabd8b
Merge pull request #501 from actions/robherley/overwrite-artifact 
Ability to overwrite an Artifact
 2024-01-18 15:11:31 -05:00
Rob Herley
05d4fe6702
run licensed against version that matches ci 2024-01-18 13:48:50 -05:00
Rob Herley
40b3052821
update readme 2024-01-18 13:44:36 -05:00
Rob Herley
49552fcb82
add overwrite tests to workflow 2024-01-18 13:33:14 -05:00
Rob Herley
79615904cc
licensed cache 2024-01-18 13:32:10 -05:00
Rob Herley
11ff42c7b1
add new overwrite input & docs 2024-01-18 13:31:03 -05:00
Rob Herley
1eb3cb2b3e
Merge pull request #497 from actions/robherley/update-readme-limit 
Update readme to reflect new artifact per job limit
 2024-01-10 15:47:13 -05:00
Rob Herley
8688a86492
Update readme to reflect new artifact/job limit 2024-01-10 15:23:13 -05:00
Konrad Pabjan
73d8b66ede
Support artifact-url output (#496) 
* Support artifact-url output

* update dist/index.js

* Update license

* Simplify output

* Update README
 2024-01-10 12:31:08 -05:00
shmuel
c320f57948
Update README.md (#492) 
Use correct id of step
 2024-01-10 10:00:06 -05:00
Rob Herley
cf8714cfea
Merge pull request #482 from actions/robherley/add-migration-docs 
Add migrations docs
 2023-12-18 18:18:28 -05:00
Rob Herley
7f16e37e88
add migrations docs 2023-12-18 18:10:52 -05:00
Rob Herley
353073034f
Merge pull request #468 from actions/robherley/misc-updates 
Some cleanup
 2023-12-14 15:14:19 -05:00
Rob Herley
6c139afa6f
update imports and old v4-beta references 2023-12-14 15:08:24 -05:00
Rob Herley
c7d193f32e
Merge pull request #466 from actions/v4-beta 
upload-artifact@v4
 2023-12-14 10:04:00 -05:00
Rob Herley
13131bb095
licensed cache 2023-12-13 16:02:47 -05:00
Rob Herley
4a6c273b98
Merge branch 'main' into v4-beta 2023-12-13 15:10:05 -05:00
Rob Herley
f391bb91a3
Merge pull request #465 from actions/robherley/v4-documentation 
Update documentation for v4
 2023-12-13 13:00:16 -05:00
Rob Herley
9653d03c4b
Apply suggestions from code review 
Co-authored-by: Konrad Pabjan <konradpabjan@github.com>
 2023-12-13 12:24:16 -05:00
Rob Herley
875b630764
add limitations section 2023-12-13 11:55:56 -05:00
Rob Herley
ecb21463e9
add compression example 2023-12-13 10:17:03 -05:00
Rob Herley
5e7604f84a
trim some repeated info 2023-12-12 23:27:17 -05:00
Rob Herley
d6437d0758
naming 2023-12-12 23:24:58 -05:00
Rob Herley
1b56155703
s/v4-beta/v4/g 2023-12-12 23:21:37 -05:00
Rob Herley
6a5077f99b
update docs and bump @actions/artifact 2023-12-12 23:19:52 -05:00
Vallie Joseph
2a6c27a029
Merge pull request #464 from actions/vmjoseph/v4-beta-more-descriptive-annotations 
Consume latest @actions/toolkit
 2023-12-11 14:32:50 -05:00