docs(github): explain where a push gets its secrets, and release ownership - #23
Merged
Merged
Conversation
The GitHub guide never mentioned secrets, and the secrets page only said to run rig deploy locally. A push deploys in Rigbox and resolves `secrets:` from the connection's encrypted runtime secrets - never from .env - so values that work locally were silently missing on pushes. Add a Runtime secrets section to the GitHub guide: what a push reads and how `name`/`from`/`optional` resolve there, what happens to a missing required or optional secret, setting values in the console or with `rig deploy`, adding a new secret, and checking which declared secrets have a value with `rig ci status`. The secrets page gains a table of where values come from for each way of deploying, and the GitHub troubleshooting page points at both.
Nothing explained which deployment owns an app, what "belongs to another active deployment" means, or how an app moves between rig deploy and a GitHub connection - so a refused deploy left users guessing. Add a Release ownership page: the three kinds of owner (a local project, a GitHub connection, an Actions binding), who can take an app over from each, what the refusal says - including the new message naming the GitHub connection and what rig deploy then does with its secrets - and the steps to move apps to a GitHub connection and back. Link it from the GitHub guide, the secrets page, multi-app ownership and deployment troubleshooting.
Only rig deploy (and the API) refuses names the connected branch does not declare; the console stores what it is given. Say so, instead of implying every path needs the declaration pushed first.
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.
A push to a GitHub connection deploys in Rigbox. It resolves
secrets:from the connection's encrypted runtime secrets, never from.env, and the docs didn't say so. Two problems followed:rig deploy("belongs to another active deployment") left users guessing.These are the docs for jona62/rig-mvp#484 and for the secrets handoff in rigbox-dev/cli#201.
What changes
guides/github.mdxgains a Runtime secrets section. It covers:name,fromandoptionalresolve there;rig deploy, and adding a new secret;rig ci status.configure/secrets.mdxgains a "Where values come from" table for each way of deploying.deploy/release-ownership.mdxis a new page. It covers:rig deploythen does with its secrets;rig deployand the API refuse names that the connected branch doesn't declare. The console stores whatever it is given.Before merging
cli-reference/commands/ci/status.mdxstill describes the oldrig ci status. The next real CLI export picks up the connection and secrets listing (see docs: describe SSH that sets itself up and the CLI inside a workspace #22).check-docs.py,build-navigation.py --checkandgenerate-cli-reference.py --checkpass. The branch merges cleanly with docs: describe SSH that sets itself up and the CLI inside a workspace #22.🤖 Generated with Claude Code