Skip to content

docs: cut the repeated bits out of the README and action.yml - #15

Merged
lens0021 merged 1 commit into
mainfrom
claude/github-actions-workflows-bbht4a
Aug 15, 2026
Merged

docs: cut the repeated bits out of the README and action.yml#15
lens0021 merged 1 commit into
mainfrom
claude/github-actions-workflows-bbht4a

Conversation

@lens0021

Copy link
Copy Markdown
Contributor

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.

  • The pin-by-SHA rationale becomes a two-line > [!NOTE] under the example. It is background for
    someone deciding how to reference the action, not part of using it.
  • token in the inputs table said "and nothing else"; it now just says what it authenticates. Same
    in action.yml, which opened with "Used for one thing:" and closed by explaining what does not
    need a token.
  • The quota explanation lived in three places. ## Why this exists keeps it, and the sentence about
    latest and git ls-remote joins it there instead of restating the 1,000/hour budget.
  • The range syntax was listed once in the detection paragraph and again 40 lines later. One list
    now, keeping the note that != and hyphen ranges are not read.
  • The outputs table sat under ## Inputs; it gets its own heading, and the prose after it moves
    under ## Version and checksum.
  • Two comments in action.yml both explained why the checksum is in the cache path and key. Merged,
    keeping the separate point about the 2 generation marker.

No behaviour changes — README.md and comments only, apart from the token input description.

Local: yamllint, rumdl, shellcheck and test/version-test.sh all pass.


Generated by Claude Code

@lens0021
lens0021 marked this pull request as ready for review August 15, 2026 14:28
@lens0021
lens0021 merged commit 285762b into main Aug 15, 2026
17 checks passed
@lens0021
lens0021 deleted the claude/github-actions-workflows-bbht4a branch August 15, 2026 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants