Documentation improvements #636
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
invisiblepancake
approved these changes
Dec 23, 2024
invisiblepancake
approved these changes
Dec 23, 2024
invisiblepancake
approved these changes
Dec 23, 2024
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.
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.
Wrap text so that it isn't clipped when rendered in: https://github.com/actions/upload-artifact?tab=readme-ov-file#inputs
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.
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.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've made a number of suggested edits to the README. I believe each is valuable, but would be happy to drop any/adjust any as desired.