From a8045443bd203901e69aa0e0e8999872c960177c Mon Sep 17 00:00:00 2001 From: Gary Sassano <10464497+garysassano@users.noreply.github.com> Date: Thu, 3 Oct 2024 13:08:53 +0200 Subject: [PATCH 1/2] Fix inconsistencies in README file --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f3cce8a..8978e05 100644 --- a/README.md +++ b/README.md @@ -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 jobs](#example-output-between-jobs) - [Overwriting an Artifact](#overwriting-an-artifact) + - [Uploading Hidden Files](#uploading-hidden-files) - [Limitations](#limitations) - [Number of Artifacts](#number-of-artifacts) - [Zip archives](#zip-archives) @@ -59,12 +60,8 @@ There is also a new sub-action, `actions/upload-artifact/merge`. For more info, ### Breaking Changes 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. - - 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. +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. 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 -| Name | Description | Example | -| - | - | - | -| `artifact-id` | GitHub ID of an Artifact, can be used by the REST API | `1234` | +| 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 From da29b1cd5e7e6d7620fc111cefb55c0587c39b43 Mon Sep 17 00:00:00 2001 From: Gary Sassano <10464497+garysassano@users.noreply.github.com> Date: Wed, 9 Oct 2024 15:33:20 +0200 Subject: [PATCH 2/2] reinstate breaking change 2 --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8978e05..58b90f5 100644 --- a/README.md +++ b/README.md @@ -60,8 +60,9 @@ There is also a new sub-action, `actions/upload-artifact/merge`. For more info, ### Breaking Changes 1. On self hosted runners, additional [firewall rules](https://github.com/actions/toolkit/tree/main/packages/artifact#breaking-changes) may be required. -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. +2. While it's not possible to upload to the same named artifact multiple times, you can overwrite it and/or merge artifacts into a single one. An example of this breaking change is outlined in [the migration guide](docs/MIGRATION.md#multiple-uploads-to-the-same-named-artifact). +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).