Skip to content

docs: add platform matrix, surface Go 1.22 requirement earlier - #3

Merged
0xProgress merged 1 commit into
mainfrom
0xProgress-bravo-ledger
Oct 31, 2026
Merged

0xProgress merged 1 commit into
mainfrom
0xProgress-bravo-ledger

Conversation

@0xProgress

@0xProgress 0xProgress commented Oct 31, 2026 •

Copy link
Copy Markdown
Owner

Based on feedback from bravo-ledger via the Reponite review campaign. The process subcommand's Linux/macOS scope was only mentioned mid-page;

  • New Platform support table after Install makes it findable before someone picks the wrong command. Go 1.22 minimum now appears near source install too, not just at the bottom of the Install section.

What this PR does

Related issue

Closes #

Type

  • New condition type (new subcommand)
  • Bug fix
  • Documentation
  • Refactor
  • Chore / CI
  • Release / build tooling

How I tested it


New condition type PRs only

Skip this section if you're not adding a subcommand.

  • An open issue existed before I started work
  • Condition implements poller.Condition (Kind, Target, Describe, SuccessMessage, Check)
  • Check returns transient "not yet" states as (state, false, nil); err != nil is reserved for fatal failures
  • Check respects ctx — a long-running evaluation cancels when the poller's deadline fires, without orphaning child processes
  • State strings returned by Check are documented in a comment and match the tip logic
  • A tip function exists for the new Kind in internal/tips — or is deliberately empty, per spec
  • cmd/<name>.go wires the condition through buildPoller + finish
  • newAllCmd dispatch (isConditionKeyword, buildSubCondition) includes the new keyword
  • Human output matches the standard failure block shape: Condition: / Last state: / optional detail / Tip:
  • --json output carries condition, target, success, elapsed_ms, timeout_ms, last_state, attempts
  • Unit tests for the condition package
  • CLI tests in cmd/ covering success, timeout, and bad-args (exit 2)
  • README.md and docs/ci-cd.md updated with the new subcommand

General checklist

  • make lint passes (vet + gofmt clean)
  • make test passes
  • make race passes, required if the PR touches internal/poller or cmd/all.go
  • PR title follows Conventional Commits (feat:, fix:, docs:, test:, refactor:, chore:, ci:)
  • No new dependency unless the PR explains why the standard library is insufficient
  • No changes to exit-code semantics (0/1/2/3) without updating README.md and internal/exitcode
  • No secrets, tokens, or private hostnames in tests, examples, or fixtures

Based on feedback from bravo-ledger via the Reponite review campaign. The process subcommand's Linux/macOS scope was only mentioned mid-page;  
- New Platform support table after Install makes it findable before someone picks the wrong command. Go 1.22 minimum now appears near source install too, not just at the bottom of the Install section.
@0xProgress
0xProgress merged commit 86afcd7 into main Oct 31, 2026
5 checks passed
@0xProgress
0xProgress deleted the 0xProgress-bravo-ledger branch October 31, 2026 14:18
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