Skip to content

Commit 29f2f77

Browse files
[docs] Update branching documentation to use new release branch naming scheme. (swiftlang#33766)
1 parent d1a033c commit 29f2f77

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/Branches.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ To switch from one set of branches to another, you can use `utils/update-checkou
1818

1919
## The Release Branches
2020

21-
| Swift | LLVM Project
22-
| ---------------- | ----------------------
23-
| swift-x.y-branch | swift/swift-x.y-branch
21+
| Swift | LLVM Project
22+
| ----------- | -----------------
23+
| release/x.y | swift/release/x.y
2424

25-
At some point before a release, a *release branch* will be created in every repository with a name like `swift-4.0-branch`. (The actual number is chosen by Apple.) After the branch has been created, commits must make it to this branch to make it into the release. In some cases, the [release manager][] for the branch will decide to merge in all additional changes from `master`; otherwise, cherry-picking changes and making a new pull request is the way to go. If there are any "patch" releases (e.g. Swift 4.0.1), they will also come from this branch.
25+
At some point before a release, a *release branch* will be created in every repository with a name like `release/5.3`. (The actual number is chosen by Apple.) After the branch has been created, commits must make it to this branch to make it into the release. In some cases, the [release manager][] for the branch will decide to merge in all additional changes from `master`; otherwise, cherry-picking changes and making a new pull request is the way to go. If there are any "patch" releases (e.g. Swift 5.3.1), they will also come from this branch.
2626

2727
Note that these branches come not from the "development" branches (above), but the "upstream" branches (below). This is because they need to contain the latest changes not just from Swift, but from the LLVM project as well. For some releases, the release branch for the LLVM project will be timed to coincide with the corresponding llvm.org release branch.
2828

@@ -35,7 +35,7 @@ Note that these branches come not from the "development" branches (above), but t
3535

3636
`swift/master-next` is a branch for LLVM that includes all changes necessary to support Swift. Changes from llvm.org's master branch are automatically merged in. Why isn't this just `swift/master`? Well, because LLVM changes *very* rapidly, and that wouldn't be very stable. However, we do want to make sure the Swift stuff keeps working.
3737

38-
If you are making changes to LLVM to support Swift, you'll probably need to work on them in `swift/master` to test them against Swift itself, but they should be committed to `swift/master-next`, and cherry-picked to the current release branch (`swift/swift-x.y-branch`) if needed. Remember, the release branches are automerged into `swift/master` on a regular basis.
38+
If you are making changes to LLVM to support Swift, you'll probably need to work on them in `swift/master` to test them against Swift itself, but they should be committed to `swift/master-next`, and cherry-picked to the current release branch (`swift/release/x.y`) if needed. Remember, the release branches are automerged into `swift/master` on a regular basis.
3939

4040
(If you're making changes to LLVM Project that *aren't* about Swift, they should generally be made on llvm.org instead, then cherry-picked to the active release branch or `swift/master`.)
4141

@@ -83,6 +83,6 @@ Some branches are *automerged* into other branches, to keep them in sync. This i
8383
- `master` is automerged into `master-next`
8484

8585
### LLVM Project
86-
- `swift/swift-x.y-branch` (the *latest* release branch) is automerged into `swift/master`
86+
- `swift/release/x.y` (the *latest* release branch) is automerged into `swift/master`
8787
- llvm.org's `master` is automerged into `swift/master-next`
88-
- llvm.org's release branch *may* be automerged into `swift/swift-x.y-branch`, if they are in sync
88+
- llvm.org's release branch *may* be automerged into `swift/release/x.y`, if they are in sync

0 commit comments

Comments
 (0)