1
0
mirror of https://github.com/actions/upload-artifact.git synced 2025-12-06 16:37:53 +01:00

Compare commits

..

18 Commits

Author SHA1 Message Date
Daniel Kennedy
330a01c490 Merge pull request #734 from actions/danwkennedy/prepare-5.0.0
Prepare `v5.0.0`
2025-10-24 14:15:34 -04:00
Daniel Kennedy
03f2824452 Update github.dep.yml 2025-10-24 14:06:12 -04:00
Daniel Kennedy
905a1ecb59 Prepare v5.0.0 2025-10-24 14:01:51 -04:00
Zachary Taylor
2d9f9cdfa9 Merge pull request #725 from patrikpolyak/patch-1
Update GHES guidance to include reference to Node 20 version
2025-10-23 10:20:12 -04:00
Patrik Polyak
9687587dec Merge branch 'main' into patch-1 2025-10-01 11:18:18 +02:00
Yang Cao
2848b2cda0 Merge pull request #727 from danwkennedy/patch-1
Readme: spell out the first use of GHES
2025-09-24 09:57:02 -04:00
Daniel Kennedy
9b511775fd Spell out the first use of GHES 2025-09-24 09:42:45 -04:00
Patrik Polyak
cd231ca1ed Update GHES guidance to include reference to Node 20 version
`v3` uses Node 16 which is deprecated. `v3-node20` has been available for a while which uses Node 20 so we should reflect this in the documentation.
2025-09-15 12:12:01 +02:00
Ben De St Paer-Gotch
de65e23aa2 Merge pull request #712 from actions/nebuk89-patch-1
Update README.md
2025-06-17 12:09:38 +01:00
Ben De St Paer-Gotch
8747d8cd76 Update README.md 2025-06-16 10:11:27 +01:00
Rob Herley
6027e3dd17 Merge pull request #681 from GhadimiR/patch-1
Update README.md
2025-03-25 09:24:05 -04:00
Ryan Ghadimi
d7079ed267 Merge branch 'main' into patch-1 2025-03-25 09:29:28 +00:00
Yang Cao
ea165f8d65 Merge pull request #685 from salmanmkc/salmanmkc/3-new-upload-artifacts-release
Update to use artifact 2.3.2 package & prepare for new upload-artifact release
2025-03-19 10:34:59 -07:00
Salman Chishti
08396203c1 Prepare for new release of actions/upload-artifact with new toolkit cache version 2025-03-19 05:38:34 -07:00
Ryan Ghadimi
99ec7df36b Update README.md 2025-03-14 15:03:00 +00:00
Yang Cao
4cec3d8aa0 Merge pull request #673 from actions/yacaovsnc/artifact_2.2.2
Update to use artifact 2.2.2 package
2025-02-21 13:56:39 -05:00
Yang Cao
e9fad966cc license cache update for artifact 2025-02-21 13:16:50 -05:00
Yang Cao
b26fd06e9d Update to use artifact 2.2.2 package 2025-02-21 13:05:59 -05:00
8 changed files with 6980 additions and 15639 deletions

View File

@@ -1,6 +1,6 @@
---
name: "@actions/artifact"
version: 2.2.1
version: 4.0.0
type: npm
summary: Actions artifact lib
homepage: https://github.com/actions/toolkit/tree/main/packages/artifact

View File

@@ -1,6 +1,6 @@
---
name: "@actions/github"
version: 6.0.0
version: 6.0.1
type: npm
summary: Actions github lib
homepage: https://github.com/actions/toolkit/tree/main/packages/github

36
.vscode/launch.json vendored Normal file
View File

@@ -0,0 +1,36 @@
{
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Debug Jest Tests",
"program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
"args": [
"--runInBand",
"--testTimeout",
"10000"
],
"cwd": "${workspaceFolder}",
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen",
"disableOptimisticBPs": true
},
{
"type": "node",
"request": "launch",
"name": "Debug Current Test File",
"program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
"args": [
"--runInBand",
"--testTimeout",
"10000",
"${relativeFile}"
],
"cwd": "${workspaceFolder}",
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen",
"disableOptimisticBPs": true
}
]
}

View File

@@ -41,7 +41,7 @@ See also [download-artifact](https://github.com/actions/download-artifact).
## v4 - What's new
> [!IMPORTANT]
> upload-artifact@v4+ is not currently supported on GHES yet. If you are on GHES, you must use [v3](https://github.com/actions/upload-artifact/releases/tag/v3).
> upload-artifact@v4+ is not currently supported on GitHub Enterprise Server (GHES) yet. If you are on GHES, you must use [v3](https://github.com/actions/upload-artifact/releases/tag/v3) (Node 16) or [v3-node20](https://github.com/actions/upload-artifact/releases/tag/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.
@@ -68,6 +68,24 @@ There is also a new sub-action, `actions/upload-artifact/merge`. For more info,
For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
## Note
Thank you for your interest in this GitHub repo, however, right now we are not taking contributions.
We continue to focus our resources on strategic areas that help our customers be successful while making developers' lives easier. While GitHub Actions remains a key part of this vision, we are allocating resources towards other areas of Actions and are not taking contributions to this repository at this time. The GitHub public roadmap is the best place to follow along for any updates on features were working on and what stage theyre in.
We are taking the following steps to better direct requests related to GitHub Actions, including:
1. We will be directing questions and support requests to our [Community Discussions area](https://github.com/orgs/community/discussions/categories/actions)
2. High Priority bugs can be reported through Community Discussions or you can report these to our support team https://support.github.com/contact/bug-report.
3. Security Issues should be handled as per our [security.md](SECURITY.md).
We will still provide security updates for this project and fix major breaking changes during this time.
You are welcome to still raise bugs in this repo.
## Usage
### Inputs
@@ -87,21 +105,19 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
# 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, does not fail the action
# 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 use default retention.
# 1 is the shortest retention.
# Maximum is based on repository settings (the default is 90 days).
# 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.
# For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
# Optional. Default is '6'
compression-level:
@@ -111,9 +127,9 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
# Optional. Default is 'false'
overwrite:
# Whether to include hidden files in the provided path in the artifact.
# Whether to include hidden files in the provided path in the artifact
# The file contents of any hidden files in the path should be validated before
# enabling this to avoid uploading sensitive information.
# enabled this to avoid uploading sensitive information.
# Optional. Default is 'false'
include-hidden-files:
```
@@ -122,8 +138,8 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
| Name | Description | Example |
| - | - | - |
| `artifact-id` | GitHub ID of the Artifact, can be used by the REST API | `1234` |
| `artifact-url` | URL to download the 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 and the artifact, run, and repository have not been deleted. | `https://github.com/example-org/example-repo/actions/runs/1/artifacts/1234` |
| `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` |
| `artifact-digest` | SHA-256 digest of an Artifact | 0fde654d4c6e659b45783a725dc92f1bfb0baa6c2de64b34e814dc206ff4aaaf |
## Examples
@@ -452,7 +468,7 @@ 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 Zip or to download individual artifact contents.
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
@@ -475,8 +491,9 @@ If you must preserve permissions, you can `tar` all of your files together befor
At the bottom of the workflow summary page, there is a dedicated section for artifacts. Here's a screenshot of something you might see:
<img src="https://user-images.githubusercontent.com/16109154/103645952-223c6880-4f59-11eb-8268-8dca6937b5f9.png" width="700" height="300">
<img src="https://github.com/user-attachments/assets/bcb7120f-f445-4a3e-9596-77f85f7e0af0" width="700" height="300">
For users who have write permissions to the repository, there is a trashcan icon that can be used to delete the artifact.
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.
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. The Digest column will display the SHA256 digest of the artifact being uploaded.

10556
dist/merge/index.js vendored

File diff suppressed because one or more lines are too long

10556
dist/upload/index.js vendored

File diff suppressed because one or more lines are too long

1098
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{
"name": "upload-artifact",
"version": "4.5.0",
"version": "5.0.0",
"description": "Upload an Actions Artifact in a workflow run",
"main": "dist/upload/index.js",
"scripts": {
@@ -29,7 +29,7 @@
},
"homepage": "https://github.com/actions/upload-artifact#readme",
"dependencies": {
"@actions/artifact": "^2.2.1",
"@actions/artifact": "^4.0.0",
"@actions/core": "^1.11.1",
"@actions/github": "^6.0.0",
"@actions/glob": "^0.5.0",