actions
/
upload-artifact
mirror of https://github.com/actions/upload-artifact
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix inconsistencies in README file

pull/624/head
Gary Sassano 2024-10-03 13:08:53 +02:00
parent 3eadd8b791
commit a8045443bd
No known key found for this signature in database
GPG Key ID: F8FE82821AD22F8F
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -31,6 +31,7 @@ See also [download-artifact](https://github.com/actions/download-artifact).
- [Example output between steps](#example-output-between-steps) - [Example output between steps](#example-output-between-steps)
- [Example output between jobs](#example-output-between-jobs) - [Example output between jobs](#example-output-between-jobs)
- [Overwriting an Artifact](#overwriting-an-artifact) - [Overwriting an Artifact](#overwriting-an-artifact)
- [Uploading Hidden Files](#uploading-hidden-files)
- [Limitations](#limitations) - [Limitations](#limitations)
- [Number of Artifacts](#number-of-artifacts) - [Number of Artifacts](#number-of-artifacts)
- [Zip archives](#zip-archives) - [Zip archives](#zip-archives)
@ -59,12 +60,8 @@ There is also a new sub-action, `actions/upload-artifact/merge`. For more info,
### Breaking Changes ### Breaking Changes
1. On self hosted runners, additional [firewall rules](https://github.com/actions/toolkit/tree/main/packages/artifact#breaking-changes) may be required. 1. On self hosted runners, additional [firewall rules](https://github.com/actions/toolkit/tree/main/packages/artifact#breaking-changes) may be required.
2. Uploading to the same named Artifact multiple times. 2. Limit of Artifacts for an individual job. Each job in a workflow run now has a limit of 500 artifacts.
3. With `v4.4` and later, hidden files are excluded by default.
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.
3. Limit of Artifacts for an individual job. Each job in a workflow run now has a limit of 500 artifacts.
4. With `v4.4` and later, hidden files are excluded by default.
For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md). For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
@ -118,9 +115,9 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
### Outputs ### Outputs
| Name | Description | Example | | Name | Description | Example |
| - | - | - | | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `artifact-id` | GitHub ID of an Artifact, can be used by the REST API | `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-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 ## Examples