docs: cut the repeated bits out of the README and action.yml - #15
Merged
Conversation
This file contains hidden or 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
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.
A fresh read of the README turned up three explanations of the REST API quota, two lists of the
range syntax, and a paragraph of supply-chain reasoning sitting in the middle of the usage section.
> [!NOTE]under the example. It is background forsomeone deciding how to reference the action, not part of using it.
tokenin the inputs table said "and nothing else"; it now just says what it authenticates. Samein
action.yml, which opened with "Used for one thing:" and closed by explaining what does notneed a token.
## Why this existskeeps it, and the sentence aboutlatestandgit ls-remotejoins it there instead of restating the 1,000/hour budget.now, keeping the note that
!=and hyphen ranges are not read.## Inputs; it gets its own heading, and the prose after it movesunder
## Version and checksum.action.ymlboth explained why the checksum is in the cache path and key. Merged,keeping the separate point about the
2generation marker.No behaviour changes —
README.mdand comments only, apart from thetokeninput description.Local: yamllint, rumdl, shellcheck and
test/version-test.shall pass.Generated by Claude Code