Skip to content

Commit 55f5a1a

Browse files
committed
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.
1 parent ecc6a0a commit 55f5a1a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
122122
123123
| Name | Description | Example |
124124
| - | - | - |
125-
| `artifact-id` | GitHub ID of an Artifact, can be used by the REST API | `1234` |
126-
| `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` |
125+
| `artifact-id` | GitHub ID of the Artifact, can be used by the REST API | `1234` |
126+
| `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` |
127127

128128
## Examples
129129

0 commit comments

Comments
 (0)