Skip to content

Docs pass: fix stale README example, document Linux requirement - #14

Merged
scruplelesswizard merged 2 commits into
mainfrom
docs/fix-readme-example-and-linux-note
Jul 31, 2026
Merged

Docs pass: fix stale README example, document Linux requirement#14
scruplelesswizard merged 2 commits into
mainfrom
docs/fix-readme-example-and-linux-note

Conversation

@scruplelesswizard

Copy link
Copy Markdown
Owner

Follow-up from REVIEW.adoc's Documentation section:

  • Drops the deprecated ::set-output syntax from the embedded README example (the real workflow files were fixed in Replace deprecated set-output command #3, but the README's copy was never updated).
  • Points the example at scruplelesswizard/split-tests@v1 instead of the stale chaosaffe/split-tests@v1-alpha.1 (GitHub's rename-redirect still resolves the old owner name, but the canonical name/tag should be what's documented).
  • Bumps the embedded example's actions/checkout@v2 to @v4 to match Bump actions/checkout from v2 to v4 in repo workflows #13.
  • Notes the Linux-only runner requirement up front, since the action installs a Linux binary.

- Drop the deprecated GitHub Actions ::set-output syntax from the
  embedded example - it was fixed in the actual workflow files (#3) but
  the README's copy was never updated, so it was teaching new adopters a
  syntax GitHub has since removed.
- Point the example at scruplelesswizard/split-tests@v1 instead of
  chaosaffe/split-tests@v1-alpha.1 (a stale pre-release tag under the
  repo's previous owner name; GitHub's redirect still resolves it, but
  the canonical name/tag should be what's documented).
- Bump the embedded example's actions/checkout@v2 to @v4 to match #13.
- Note the Linux-only runner requirement up front.
@scruplelesswizard
scruplelesswizard merged commit 660f34a into main Jul 31, 2026
5 checks passed
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.

1 participant