diff --git a/MAINTAINERS.md b/MAINTAINERS.md index e542cb0..7f7722c 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -6,23 +6,25 @@ This document describes some instructions for maintainers. Other contributors an When setting up the repository on GitHub, configure the following settings: -- Under `Secrets`: +- Under `General` → `Pull Requests`, enable `Automatically delete head branches`. +- Under `Secrets and variables`: - Under `Actions`, add the following repository secrets with appropriate values: - `CRATES_IO_TOKEN` - `DOCKER_PASSWORD` - - Under `Dependabot`, add the `DOCKER_PASSWORD` repository secret with an appropriate value (e.g., that of the corresponding secret above). -- Under `Branches`, add a branch protection rule for the `main` branch. - - Enable `Require status checks to pass before merging`. - - Enable `Require branches to be up to date before merging`. - - Add the following status checks: + - Under `Dependabot`, add the `DOCKER_PASSWORD` repository secret from above. +- Under `Branches`, click `Add a branch ruleset` and configure it as follows: + - For the ruleset name, you can use the name of the branch: `main`. + - Set `Enforcement status` to `Active` + - Under `Targets` → `Target branches`, click `Add target` and select `Include default branch` from the dropdown menu. + - Under `Rules` → `Branch rules`, check `Require status checks to pass` and configure it as follows before clicking the `Create` button: + - Enable `Require branches to be up to date before merging` + - Click the `Add checks` button and add the following (you may need to use the search box to find them): - `Build for Linux` - `Build for Windows` - `Build for macOS` - `Install on Ubuntu` - `Install on macOS` - `Publish a release if applicable` - - Enable `Include administrators`. -- Under `Options`, enable `Automatically delete head branches`. The GitHub workflow will fail initially because the jobs which test the installer script will not find any release to download. You'll need to bootstrap a release by temporarily removing those jobs or changing them to no-ops. Be aware that the `create-release` job is configured to only run on the `main` branch, so you may also need to temporarily change that depending on which branch you're working on.