Skip to content

Commit 5168296

Browse files
authored
Merge pull request #246 from stepchowfun/maintainers
Update the MAINTAINERS instructions
2 parents 8fd0652 + 519511b commit 5168296

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

MAINTAINERS.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,25 @@ This document describes some instructions for maintainers. Other contributors an
66

77
When setting up the repository on GitHub, configure the following settings:
88

9-
- Under `Secrets`:
9+
- Under `General``Pull Requests`, enable `Automatically delete head branches`.
10+
- Under `Secrets and variables`:
1011
- Under `Actions`, add the following repository secrets with appropriate values:
1112
- `CRATES_IO_TOKEN`
1213
- `DOCKER_PASSWORD`
13-
- Under `Dependabot`, add the `DOCKER_PASSWORD` repository secret with an appropriate value (e.g., that of the corresponding secret above).
14-
- Under `Branches`, add a branch protection rule for the `main` branch.
15-
- Enable `Require status checks to pass before merging`.
16-
- Enable `Require branches to be up to date before merging`.
17-
- Add the following status checks:
14+
- Under `Dependabot`, add the `DOCKER_PASSWORD` repository secret from above.
15+
- Under `Branches`, click `Add a branch ruleset` and configure it as follows:
16+
- For the ruleset name, you can use the name of the branch: `main`.
17+
- Set `Enforcement status` to `Active`
18+
- Under `Targets``Target branches`, click `Add target` and select `Include default branch` from the dropdown menu.
19+
- Under `Rules``Branch rules`, check `Require status checks to pass` and configure it as follows before clicking the `Create` button:
20+
- Enable `Require branches to be up to date before merging`
21+
- Click the `Add checks` button and add the following (you may need to use the search box to find them):
1822
- `Build for Linux`
1923
- `Build for Windows`
2024
- `Build for macOS`
2125
- `Install on Ubuntu`
2226
- `Install on macOS`
2327
- `Publish a release if applicable`
24-
- Enable `Include administrators`.
25-
- Under `Options`, enable `Automatically delete head branches`.
2628

2729
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.
2830

0 commit comments

Comments
 (0)