Remove hub-only doc pointers from carried sections (#368, PR-3b) - #372
Merged
Conversation
The carried Branching Model and Documentation Style sections pointed at hub-only docs a downstream reader cannot follow. - Branching Model: drop the two references to the hub-only docs/repo-config-carry.md (the export/import procedure and the brownfield migration procedure). The behavioral content stays - import the committed repo-config/*.json payloads, configure.sh selects the payload, and brownfield repos temporarily disable the ruleset to re-sign. The full setup procedure lives in the hub-only STANDUP.md. - Documentation Style: drop the "or the hub-only reports/conformance-matrix.md" from the no-coordination-references rule; the onboarding or conformance issue is the remaining destination. The one reports/conformance-matrix.md reference that stays is inside the hub-only Repository Onboarding section, not a carried contaminant. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the carried governance text in AGENTS.md to avoid pointing downstream readers at hub-only documentation, while keeping the underlying behavioral guidance intact.
Changes:
- Remove hub-only
docs/repo-config-carry.mdreferences from the carried Branching Model ruleset-configuration guidance. - Remove the hub-only
reports/conformance-matrix.mdmention from the carried Documentation Style Conventions "no coordination references" rule.
Uh oh!
There was an error while loading. Please reload this page.
Copilot round-1 finding: the `gh api -X POST .../rulesets` shorthand on the edited line was inconsistent with the doc's explicit repos/<owner>/<repo>/... convention. Spell it out. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
AGENTS.md:49
- The
gh apiendpoint example is unquoted (repos/<owner>/<repo>/rulesets). In a POSIX shell,<owner>/<repo>will be parsed as redirection operators, so the command is not copy/pasteable as written. Quote the endpoint (consistent with thegit/refsexample a few lines above) so the placeholder brackets are treated as literal text.
- **Configuring branch protection on a fleet repo: don't hand-build the rules.** Reconstructing the rules by hand is error-prone and has gone wrong on past ports. First delete **all** legacy classic branch-protection rules and any stray rulesets (rulesets are the *only* mechanism used), then create **exactly two rulesets named `develop` and `main`** by importing the committed `repo-config/*.json` ruleset payloads via `gh api -X POST repos/<owner>/<repo>/rulesets` (`gh ruleset` is read-only). The names are load-bearing - this file and the workflows reference them. Operational repos import [`operational/develop.json`](./repo-config/operational/develop.json) as their `develop` ruleset (the `main` ruleset is shared); [`configure.sh`](./repo-config/configure.sh) selects the right develop payload from the registry `workflowModel` automatically. **Brownfield repos** (pre-existing history) need an extra step: `Require signed commits` rejects legacy unsigned commits and the admin bypass does not cover `git push --force`, so re-signing requires temporarily disabling the ruleset.
Copilot round-2 low-confidence finding (correct, and self-introduced in round 1): an unquoted repos/<owner>/<repo>/rulesets parses <owner>/<repo> as shell redirections. Quote it, matching the git/refs example a few lines above. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Follow-up to PR-3 (#368). The carried Branching Model and Documentation Style Conventions sections pointed at hub-only docs a downstream reader cannot follow.
docs/repo-config-carry.md(the export/import procedure, and the brownfield migration procedure). The behavioral content stays — import the committedrepo-config/*.jsonpayloads,configure.shselects the payload, brownfield repos temporarily disable the ruleset to re-sign. The full setup procedure already lives in the hub-onlySTANDUP.md.reports/conformance-matrix.md" from the no-coordination-references rule; the onboarding or conformance issue remains the destination.The one
reports/conformance-matrix.mdreference that stays is inside the hub-only Repository Onboarding section, so it is correctly not a carried contaminant.Deliberately minimal —
configure.sh(also hub-only) and the onboarding-flavored setup mechanics in that Branching bullet are left for a possible follow-up. Held ondevelop.