Repository navigation
docs: add a staging setup and a Try it section for each PR - #97
Merged
Merged
Conversation
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.
thebrandonlucas
force-pushed
the
docs/try-pr-on-staging
branch
from
October 22, 2026 21:37
7e871fe to
09f2168
Compare
This was referenced Oct 22, 2026
tee8z
reviewed
Oct 26, 2026
tee8z
left a comment
Contributor
There was a problem hiding this comment.
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.
thebrandonlucas
marked this pull request as ready for review
November 4, 2026 16:30
This was referenced Nov 4, 2026
tee8z
approved these changes
Nov 4, 2026
tee8z
left a comment
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
docs/development.md→ Try a pull request on staging.envset up, paste three lines: aliasscripts/voltage-stagingasvoltage,voltage --build, andvoltage login --account me --credential-store file. Rebuild after pulling new commits.AGENTS.mdshblocks usingvoltageand--account me, a one-line expectation per command, every added or changed--helpand docs example (with agit diff … | grep '^+.*voltage 'to find them), the affected variants (piped,--json,--quiet,--color never,--no-input), sending commands marked, andNothing to try on stagingfor refactors..github/pull_request_template.mdTry 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:
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 everyvoltageline indocs/development.md), andpython3 scripts/check-coverage.py: all pass.scripts/crap-report.sh, cargo-llvm-cov 0.8.5, knots 1.16.0): 0 violations. The highest score is 18.10 (wait_for_paymentinsrc/api.rs), which this PR does not change;src/andtests/are unchanged here.no-changelogbecause nothing user-visible changes.Stack
Stack #135, layer 1 of 9 (bottom targets
master):--allonorganizations,environments, andprofiles listVOLTAGE_*variablevoltage context --format envvoltage feedbackand panicsvoltage environments createflake.nixwith a KaifileThe layers are chained with merge commits, because history is not rewritten. Use squash and merge, bottom first.