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] 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 90dda65..691e4c0 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