Merge c11cddaf41 into 6027e3dd17

Merge pull request #681 from GhadimiR/patch-1
Update README.md
2025-09-22 11:47:50 +00:00 · 2025-03-30 16:53:13 +05:30 · 2025-03-25 09:24:05 -04:00 · 2025-03-25 09:29:28 +00:00 · 2025-03-14 15:03:00 +00:00 · 2024-12-27 15:08:28 -05:00
1 changed files with 16 additions and 13 deletions
--- a/README.md
+++ b/README.md
@ -87,19 +87,21 @@ 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:

-    # 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:

    # 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:

@ -109,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:
 ```
@ -120,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` |
 | `artifact-digest` | SHA-256 digest of an Artifact | 0fde654d4c6e659b45783a725dc92f1bfb0baa6c2de64b34e814dc206ff4aaaf |

 ## Examples
@ -450,7 +452,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

@ -473,8 +475,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">

-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.
+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. The Digest column will display the SHA256 digest of the artifact being uploaded.
Author	SHA1	Message	Date
Josh Soref	2072a9af39	Merge `c11cddaf41` into `6027e3dd17`	2025-03-30 16:53:13 +05:30
Rob Herley	6027e3dd17	Merge pull request #681 from GhadimiR/patch-1 Some checks failed Code scanning - action / CodeQL-Build (push) Failing after 1s Details Licensed / Check licenses (push) Failing after 2s Details 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
Ryan Ghadimi	99ec7df36b	Update README.md	2025-03-14 15:03:00 +00:00
Josh Soref	c11cddaf41	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.	2024-12-27 15:08:28 -05:00
Josh Soref	6ee0aee05d	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.	2024-12-27 15:08:28 -05:00
Josh Soref	0387148d8c	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.	2024-12-27 15:08:28 -05:00
Josh Soref	694ad020c0	Fix `include-hidden-files` documentation grammar	2024-12-27 15:05:56 -05:00
Josh Soref	9a6f90fdff	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	2024-12-27 15:05:56 -05:00
Josh Soref	a44bc71eb1	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.	2024-12-27 15:05:56 -05:00
Josh Soref	319676eefa	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.	2024-12-27 15:05:56 -05:00