Skip to content

Refresh documentation - #169

Merged
DaveLiddament merged 1 commit into
masterfrom
docs/refresh
Nov 6, 2026
Merged

DaveLiddament merged 1 commit into
masterfrom
docs/refresh

Conversation

@DaveLiddament

Copy link
Copy Markdown
Owner
  • Exit codes table in the README — CI consumers script against these, but only remove's 0/1 was discoverable without reading ErrorReporter. Documents 11–16 and 100. (Note: Add support for PHPStan error identifiers #161 adds exit 17 and Harden error handling for invalid input #164 adds exit 18 — I'll add those rows once they merge, or they can be folded in here if this merges last.)
  • Output formats list — junit existed but wasn't listed. (toon will need adding when its PR lands.)
  • GitHub Actions examples — the README recommended actions/checkout@v2, which runs a deprecated Node runtime; now v4. The fetch-depth: 0 advice (the actual point of the section) is unchanged.
  • Coverage badge link — pointed at composer.json#L109 in a 2019 commit; now links to master.
  • docs/SarbFormat.md — now states the --input-format code (sarb-json) and documents the previously-undocumented sarb-relative-json variant (relative_path key instead of file).

One thing deliberately not included: a CHANGELOG. Tags exist up to 1.9.0 but there's no changelog or documented release process — happy to backfill one from the git history as a follow-up if wanted.

- Document the exit codes (CI consumers script against these; only 0/1
  from remove were previously discoverable without reading the source).
- Add junit to the list of output formats (it was missing).
- Update the GitHub Actions examples from actions/checkout@v2 (which
  runs a deprecated Node runtime) to v4.
- Fix the code coverage badge link (pointed at a line number in a 2019
  commit of composer.json).
- SarbFormat.md: state the input format code (sarb-json) and document
  the sarb-relative-json variant, which was previously undocumented.
@DaveLiddament
DaveLiddament merged commit 15579c9 into master Nov 6, 2026
12 checks passed
@DaveLiddament
DaveLiddament deleted the docs/refresh branch November 6, 2026 14:25
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