From 38ea23d5cee1912c6130dc88af941f10afb89bd2 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:27:20 -0400 Subject: [PATCH 1/7] Improve `if-no-files-found` documentation If `if-no-files-found: ignore` and `overwrite: false` and an artifact already exists, the action will fail, so clarify that `ignore` doesn't guarantee the action won't fail. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f3cce8a9..9e568533 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ 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, the action does not fail + # ignore: Do not output any warnings or errors, does not fail the action # Optional. Default is 'warn' if-no-files-found: From fd9988342329c884ea22ae2172a82d552b94fbee Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:28:16 -0400 Subject: [PATCH 2/7] Improve `retention-days` documentation Clarify that `retention-days: 0` is a valid configuration which is numerically less than 1, but that the shortest retention is `1` (it is _not_ a minimum value according to Math/Numbers/Integers, it's just the shortest retention value). Clarify that the maximum `retention-days` value is configured per repository (which implicitly inherits from organizations...) but that the default for repositories is 90 days. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9e568533..48a805e9 100644 --- a/README.md +++ b/README.md @@ -91,9 +91,10 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md). # 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. + # 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). # Optional. Defaults to repository settings. retention-days: From 3ebf8b2556e37fcf514dbf339cde6af95c4a13fe Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:29:06 -0400 Subject: [PATCH 3/7] Improve `compression-level` documentation Wrap text so that it isn't clipped when rendered in: https://github.com/actions/upload-artifact?tab=readme-ov-file#inputs --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 48a805e9..8ae95999 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,8 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md). # 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: From ecc6a0a912a3af5cd71e979ddf0fc38637944f9a Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:30:05 -0400 Subject: [PATCH 4/7] Fix `include-hidden-files` documentation grammar --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ae95999..90dda65b 100644 --- a/README.md +++ b/README.md @@ -111,9 +111,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 - # enabled this to avoid uploading sensitive information. + # enabling this to avoid uploading sensitive information. # Optional. Default is 'false' include-hidden-files: ``` From 55f5a1aa627b1f35bee83409aeab4110f5ce7179 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:30:37 -0400 Subject: [PATCH 5/7] Improve outputs documentation Use `the` for `artifact-id` as it's a precise instance and not an amorphous artifact. Fix boolean grammar for `artifact-url` -- all conditions must be true in order for the `artifact-url` to be valid. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 90dda65b..691e4c09 100644 --- a/README.md +++ b/README.md @@ -122,8 +122,8 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md). | 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` | +| `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` | ## Examples From f8fff0c1f0fe85ab0ffe072d767dc2f43c7f1101 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:31:47 -0400 Subject: [PATCH 6/7] Improve Zip archives documentation grammar As the format is `Zip`, it's wrong to precede it with an article `a` which would be more appropriate for an instance of the format. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 691e4c09..626266bc 100644 --- a/README.md +++ b/README.md @@ -451,7 +451,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 a 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 Zip or to download individual artifact contents. ### Permission Loss From 6201cb9bfac4ef12e7a304bb8bdf60f4e8869691 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:32:20 -0400 Subject: [PATCH 7/7] Improve trashcan documentation Reorder paragraph to simplify messaging for only users with write permissions instead of getting people's hopes up that there might be a trash can only to dash it a sentence later. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 626266bc..3b5b8348 100644 --- a/README.md +++ b/README.md @@ -476,6 +476,6 @@ At the bottom of the workflow summary page, there is a dedicated section for art -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. +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.