docs: document required GitHub repository settings for scaffolded plugins - #58
Merged
Conversation
…gins Adds docs/github-repository-settings.md covering repository-side configuration that the inherited workflows expect: required secrets, branch protection on main (including the release.yaml push interaction with "Require a pull request before merging"), the matrix-expanded required status check names, and dependabot assignee setup. Links the new doc from README "Where to next" and docs/getting-started.md "After Creating Your Repository". Closes #48
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
2 participants
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.
Summary
docs/github-repository-settings.mdcovering the GitHub-side configuration the inherited workflows depend on: required secrets, branch protection onmain(with therelease.yamlpush interaction with "Require a pull request before merging" called out), the matrix-expanded required status check names (test (3.10)throughtest (3.13)), and dependabot assignee setup.PYPI_API_TOKEN.README.md"Where to next" anddocs/getting-started.md"After Creating Your Repository".Companion to the existing
docs/github-workflows.md, which already documents how to mint each token; this doc covers the repository-side settings that go alongside it.Closes #48
Test plan
toxpasses locally (docs-only change, but verified)