You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: MAINTAINERS.md
+10-8Lines changed: 10 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -6,23 +6,25 @@ This document describes some instructions for maintainers. Other contributors an
6
6
7
7
When setting up the repository on GitHub, configure the following settings:
8
8
9
-
- Under `Secrets`:
9
+
- Under `General` → `Pull Requests`, enable `Automatically delete head branches`.
10
+
- Under `Secrets and variables`:
10
11
- Under `Actions`, add the following repository secrets with appropriate values:
11
12
-`CRATES_IO_TOKEN`
12
13
-`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):
18
22
-`Build for Linux`
19
23
-`Build for Windows`
20
24
-`Build for macOS`
21
25
-`Install on Ubuntu`
22
26
-`Install on macOS`
23
27
-`Publish a release if applicable`
24
-
- Enable `Include administrators`.
25
-
- Under `Options`, enable `Automatically delete head branches`.
26
28
27
29
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.
0 commit comments