Add repository rulesets and a docs section to configure the GitHub repository #192
Conversation
This file contains 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
Rulesets simplify the branch protection configuration as you can import and export them. To make users life easier while configuring the repository we provide a new set with the recommended configuration. For more info see: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets Signed-off-by: Leandro Lucarella <[email protected]>
llucax
added
part:docs
github-actions
bot
removed
part:docs
This is only to make them a bit more friendly to the eyes when looking at the text version. Signed-off-by: Leandro Lucarella <[email protected]>
This is based on the instructions in the Wiki: https://github.com/frequenz-floss/frequenz-repo-config-python/wiki/Configuring-a-new-GitHub-repository Only a few adjustments are made to fix a few out of date data and to make it fit better to the current existing documentation. The instructions to configure the `RELEASE_NOTES.md` update check is removed because now it's spread in the rest of the configuration (the adding of the label is moved to the Labels section, and the check is included in the rulesets now). After this commit is merged they will be superseded by the instructions in the docs. To build the links to the rulesets, we add a new mkdocs macro variable to get the current default branch, which is only used when there is no GitHub information about the current version (mainly when running locally). Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
| @@ -100,7 +100,7 @@ This will only install your package in *editable* mode and the minimum | |||
| dependencies required to run `nox`. It will then run all `nox` default | |||
| sessions, which include running linters and tests. | |||
|
|
|||
| !!! note | |||
| !!! Tip | |||
There was a problem hiding this comment.
Oh, that was changed on purpose, is more a tip than a note, forgot to mention it in the commit
matthias-wende-frequenz
approved these changes
Dec 7, 2023
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.
This is based on the instructions in the Wiki.
Only a few adjustments are made to fix a few out of date data and to make it fit better to the current existing documentation.
The instructions to configure the
RELEASE_NOTES.mdupdate check is removed because now it's spread in the rest of the configuration (the adding of the label is moved to the Labels section, and the check is included in the rulesets now).After this commit is merged they will be superseded by the instructions in the docs.
To build the links to the rulesets, we add a new mkdocs macro variable to get the current default branch, which is only used when there is no GitHub information about the current version (mainly when running locally).