Skip to content

Commit c858513

Browse files
authored
Merge pull request #20171 from Homebrew/core_main
docs: homebrew-core's default branch is now `main`
2 parents 53bb328 + e11952a commit c858513

3 files changed

Lines changed: 12 additions & 12 deletions

File tree

docs/Formula-Cookbook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1332,9 +1332,9 @@ Packages requiring BLAS/LAPACK linear algebra interfaces should link to [OpenBLA
13321332

13331333
## How to start over (reset to upstream)
13341334

1335-
Have you created a real mess in Git which stops you from creating a commit you want to submit to us? You might want to consider starting again from scratch. Your changes to the Homebrew `master` branch can be reset by running:
1335+
Have you created a real mess in Git which stops you from creating a commit you want to submit to us? You might want to consider starting again from scratch. Your changes to the Homebrew `main` branch can be reset by running:
13361336

13371337
```sh
1338-
git checkout -f master
1338+
git checkout -f main
13391339
git reset --hard origin/HEAD
13401340
```

docs/Homebrew-homebrew-core-Maintainer-Guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ PRs modifying formulae that don't need bottles or making changes that don't requ
3333

3434
Otherwise, you should use `brew pr-pull` (or `rebase`/`cherry-pick` contributions).
3535

36-
Don’t `rebase` until you finally `push`. Once `master` is pushed, you can’t `rebase`: **you’re a maintainer now!**
36+
Don’t `rebase` until you finally `push`. Once `main` is pushed, you can’t `rebase`: **you’re a maintainer now!**
3737

3838
Cherry-picking changes the date of the commit, which kind of sucks.
3939

@@ -172,7 +172,7 @@ For an explanation of why this happens, read the [Ubuntu 11.04 Toolchain documen
172172

173173
Some formulae (e.g. Python, OpenSSL, ICU, Boost) have a large number of dependents. This makes updating these formulae (or their dependents) difficult because the standard procedure involves updating a large number of formulae in a single pull request. An alternative procedure that can significantly simplify this process is to use a staging branch.
174174

175-
The idea of using a staging branch is to merge updates and publish bottles for the affected formula to a non-default branch. This allows work to be done incrementally in smaller PRs, instead of in one giant PR that touches many formulae. When the staging branch is ready, it can be merged to the `master`/default branch.
175+
The idea of using a staging branch is to merge updates and publish bottles for the affected formula to a non-default branch. This allows work to be done incrementally in smaller PRs, instead of in one giant PR that touches many formulae. When the staging branch is ready, it can be merged to the `main`/default branch.
176176

177177
Before making use of a staging branch, there is one important disadvantage to consider: once you have merged bottle updates to the staging branch, it is **very difficult** to take them back. This typically involves deleting uploaded bottles, which will occasionally require an owner of the Homebrew GitHub organisation to delete uploaded bottles one at a time.
178178

@@ -184,15 +184,15 @@ Here is a rough outline of how to use a staging branch:
184184

185185
1. Open an issue in homebrew-core inviting contributors to help. Be sure to include instructions for how to do so, and a checklist of formulae that need to be updated. See [Homebrew/homebrew-core#134251](https://github.com/Homebrew/homebrew-core/issues/134251) for an example.
186186

187-
1. Open a _draft_ PR that merges the staging branch into the `master` branch. This allows you to keep track of the work done so far. You may wish to apply the [`no long build conflict`](https://github.com/Homebrew/homebrew-core/labels/no%20long%20build%20conflict) label to this PR to avoid conflicting changes from being merged to the `master` branch.
187+
1. Open a _draft_ PR that merges the staging branch into the `main` branch. This allows you to keep track of the work done so far. You may wish to apply the [`no long build conflict`](https://github.com/Homebrew/homebrew-core/labels/no%20long%20build%20conflict) label to this PR to avoid conflicting changes from being merged to the `main` branch.
188188

189-
1. Open PRs targeting the staging branch that update the affected formulae. Each PR should touch as few formulae as possible. The typical PR that targets the staging branch will update only one formula at a time. Staging branch PRs can be merged using the same process as PRs that target the `master` branch. Ideally, these PRs should be opened in [topological order](https://en.wikipedia.org/wiki/Topological_sorting) according to the dependency graph, but we don't currently have good tooling for generating a topological sort. (Help wanted.)
189+
1. Open PRs targeting the staging branch that update the affected formulae. Each PR should touch as few formulae as possible. The typical PR that targets the staging branch will update only one formula at a time. Staging branch PRs can be merged using the same process as PRs that target the `main` branch. Ideally, these PRs should be opened in [topological order](https://en.wikipedia.org/wiki/Topological_sorting) according to the dependency graph, but we don't currently have good tooling for generating a topological sort. (Help wanted.)
190190

191191
1. Label PRs that target the staging branch with the [`staging-branch-pr`](https://github.com/Homebrew/homebrew-core/labels/staging-branch-pr) label for ease of tracking and review. (TODO: Add some automation for this to homebrew-core.)
192192

193-
1. Monitor the draft PR you created in step 3 above for merge conflicts. If you encounter a merge conflict, you must resolve those conflicts in a staging branch PR that merges the `master` branch into the staging branch.
193+
1. Monitor the draft PR you created in step 3 above for merge conflicts. If you encounter a merge conflict, you must resolve those conflicts in a staging branch PR that merges the `main` branch into the staging branch.
194194

195-
1. When the staging branch is ready to be merged into `master`, mark the draft PR as ready for review and merge it into the `master` branch. Your PR may spend a long time in the merge queue waiting for the bottle fetch tests to run.
195+
1. When the staging branch is ready to be merged into `main`, mark the draft PR as ready for review and merge it into the `main` branch. Your PR may spend a long time in the merge queue waiting for the bottle fetch tests to run.
196196

197197
For examples of uses of the staging branch, see homebrew-core PRs labelled [`openssl-3-migration-staging`](https://github.com/Homebrew/homebrew-core/labels/openssl-3-migration), [Homebrew/homebrew-core#134260](https://github.com/Homebrew/homebrew-core/pull/134260), or [Homebrew/homebrew-core#133611](https://github.com/Homebrew/homebrew-core/pull/133611).
198198

docs/How-To-Open-a-Homebrew-Pull-Request.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,13 @@ Before creating a new cask, please read [Acceptable Casks](Acceptable-Casks.md).
9292

9393
To make changes on a new branch and submit it for review, create a GitHub pull request with the following steps:
9494

95-
1. Check out the `master` branch:
95+
1. Check out the `main` branch:
9696

9797
```sh
98-
git checkout master
98+
git checkout main
9999
```
100100

101-
2. Retrieve new changes to the `master` branch:
101+
2. Retrieve new changes to the `main` branch:
102102

103103
```sh
104104
brew update
@@ -157,7 +157,7 @@ To make changes based on feedback:
157157
3. Squash new commits into one commit per formula:
158158

159159
```sh
160-
git rebase --interactive origin/master
160+
git rebase --interactive origin/HEAD
161161
```
162162

163163
* If you are working on a PR for a single formula, `git commit --amend` is a convenient way of keeping your commits squashed as you go.

0 commit comments

Comments
 (0)