Skip to content

docs: add a staging setup and a Try it section for each PR - #97

Merged
thebrandonlucas merged 3 commits into
masterfrom
docs/try-pr-on-staging
Nov 4, 2026
Merged

thebrandonlucas merged 3 commits into
masterfrom
docs/try-pr-on-staging

Conversation

@thebrandonlucas

@thebrandonlucas thebrandonlucas commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Bottom of stack #135; not part of the look-and-feel stack (#92).

Problem

Pull request descriptions did not say what to run on staging or what to look for, so each reviewer worked out their own commands.

Change

Where What
docs/development.md → Try a pull request on staging On the PR's branch, with .env set up, paste three lines: alias scripts/voltage-staging as voltage, voltage --build, and voltage login --account me --credential-store file. Rebuild after pulling new commits.
AGENTS.md New step 6 under "Before you request review", and a Try it on staging section with the rules: one setup line, paste-ready sh blocks using voltage and --account me, a one-line expectation per command, every added or changed --help and docs example (with a git diff … | grep '^+.*voltage ' to find them), the affected variants (piped, --json, --quiet, --color never, --no-input), sending commands marked, and Nothing to try on staging for refactors.
.github/pull_request_template.md A Try it on staging stub, plus a checklist line for it.

Try it on staging

Nothing to try on staging: this changes only contributor docs and the PR template. To check the setup block itself, paste it from the repository root on this branch:

alias voltage="$PWD/scripts/voltage-staging"
voltage --build
voltage login --account me --credential-store file

Expect: the build finishes, your browser opens on the staging approval page, and once you approve, the login is saved.

Checks

Run on the head after merging master (b32e028):

  • cargo fmt --check, cargo clippy --locked --all-targets -- -D warnings, cargo machete --with-metadata, cargo test --locked (199 unit and 149 integration tests, including the docs-example tests that parse every voltage line in docs/development.md), and python3 scripts/check-coverage.py: all pass.
  • CRAP report (scripts/crap-report.sh, cargo-llvm-cov 0.8.5, knots 1.16.0): 0 violations. The highest score is 18.10 (wait_for_payment in src/api.rs), which this PR does not change; src/ and tests/ are unchanged here.
  • Labeled no-changelog because nothing user-visible changes.

Stack

Stack #135, layer 1 of 9 (bottom targets master):

# PR Change
1 #97 (this PR) Staging setup and a Try it section for each PR
2 #120 --all on organizations, environments, and profiles list
3 #128 Warn when a profile or flag overrides a set VOLTAGE_* variable
4 #129 voltage context --format env
5 #127 Replace hand-rolled terminal code with crossterm
6 #126 Pick the wallet, organization, or environment to show
7 #130 Prefilled GitHub issue links from voltage feedback and panics
8 #123 voltage environments create
9 #131 Replace flake.nix with a Kaifile

The layers are chained with merge commits, because history is not rewritten. Use squash and merge, bottom first.

@thebrandonlucas thebrandonlucas added the no-changelog Skip the Changelog check: the change has no user-visible effect label Oct 22, 2026
The development guide gains a short block that aliases the staging wrapper,
builds, and logs in, for checking a pull request's branch by hand. AGENTS.md
and the pull request template ask each pull request for a "Try it on
staging" section: the exact commands to paste after that setup, every
changed help and docs example, and what to expect.

@tee8z tee8z left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rest looks good. scripts/voltage-staging --build exists and works as the setup block assumes, the template change is clean, and no-changelog fits. The branch is 20 commits behind master but merges cleanly. One structural fix is inline.

Comment thread AGENTS.md Resolved

@tee8z tee8z left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved at b32e028. The CRAP paragraph is back under Before you request review (my earlier inline comment), and Try it on staging follows it. The setup block, the template stub, and the no-changelog label fit. CRAP is not required: src/ and tests/ are unchanged. CI is green on this head.

@thebrandonlucas
thebrandonlucas merged commit bc0055e into master Nov 4, 2026
7 checks passed
@thebrandonlucas
thebrandonlucas deleted the docs/try-pr-on-staging branch November 4, 2026 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog Skip the Changelog check: the change has no user-visible effect

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants