Skip to content

Commit 3da8336

Browse files
Merge pull request #520 from apiraino/clarify-stable-backports
Mention stable backporting procedure
2 parents ca35de9 + e326e27 commit 3da8336

File tree

4 files changed

+27
-12
lines changed

4 files changed

+27
-12
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ documentation useful for members of [The Rust Programming Language].
88

99
# Development
1010

11-
You can build a local version by running the following command.
11+
You can build a local version by installing [mdbook] and running the following command.
1212

1313
```console
1414
mdbook build
@@ -18,6 +18,8 @@ This will build and run the `blacksmith` tool automatically. When developing
1818
it's recommended to use the `serve` command to launch a local server to allow
1919
you to easily see and update changes you make.
2020

21+
[mdbook]: https://github.com/rust-lang/mdBook
22+
2123
```console
2224
mdbook serve
2325
```
@@ -59,7 +61,7 @@ Any Rust team can have a section in the Rust Forge. If you'd like to add your te
5961
```
6062

6163
If you run `mdbook build`, `mdbook` will automatically create the folder and file for your team.
62-
64+
6365
It's recommended that you put general team information in `src/<TEAM_NAME>/README.md`, such as where the meetings happen, repositories that the team manages, links to chat platforms, etc. Larger topics should be made as a subpage, e.g. (`src/release/topic.md`).
6466

6567
```markdown

book.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ no-section-label=true
1515
git-repository-url="https://github.com/rust-lang/rust-forge"
1616

1717
[output.html.redirect]
18-
"beta-backporting.html" = "/release/beta-backporting.html"
18+
"beta-backporting.html" = "/release/backporting.html"
19+
"release/beta-backporting.html" = "/release/backporting.html"
1920
"bibliography.html" = "https://rustc-dev-guide.rust-lang.org/appendix/bibliography.html"
2021
"channel-layout.html" = "/infra/channel-layout.html"
2122
"debugging.html" = "https://rustc-dev-guide.rust-lang.org/compiler-debugging.html"

src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
- [Libs](./libs/README.md)
7070
- [Maintaining the standard library](./libs/maintaining-std.md)
7171
- [Release](./release/README.md)
72-
- [Beta Backporting](./release/beta-backporting.md)
72+
- [Backporting](./release/backporting.md)
7373
- [Preparing Release Notes](./release/release-notes.md)
7474
- [Release Process](./release/process.md)
7575
- [Rollup Procedure](./release/rollups.md)

src/release/beta-backporting.md renamed to src/release/backporting.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
# Beta Backporting
1+
# Backporting
22

3-
There's a steady trickle of patches that need to be ported to the beta branch.
4-
Only a few people are even aware of the process, but this is actually something
5-
anybody can do.
3+
There's a steady trickle of patches that need to be ported to the beta and stable branch.
4+
Only a few people are even aware of the process, but this is actually something anybody can do.
65

7-
## Backporting in `rust-lang/rust`
6+
## Beta backporting in `rust-lang/rust`
87

98
When somebody identifies a PR that should be backported to beta they tag it
109
[`beta-nominated`](https://github.com/rust-lang/rust/pulls?q=is%3Apr+is%3Aclosed+label%3Abeta-nominated).
1110
That means they want one of the teams to evaluate whether the patch should be
12-
backported. I also suggest applying the `I-nominated` and and a `T-` (team) tag
11+
backported. It is also suggested applying the `I-nominated` and and a `T-` (team) tag
1312
as appropriate: that'll _really_ get their attention. Anybody with triage access
1413
is free to make these tags. Backports are mostly done to fix regressions. If the
1514
team thinks it should be backported they'll then additionally tag it
@@ -33,7 +32,21 @@ tag_ (people forget to do this a lot). This last step indicates that the
3332
backport has been completed, so the `beta-nominated` and `beta-accepted` tags
3433
have three states.
3534

36-
## Backporting in `rust-lang/cargo`
35+
If, on the other hand, a backport is declined the `beta-nominated` label is
36+
removed, closing the procedure.
37+
38+
## Stable backporting in `rust-lang/rust`
39+
40+
Backports to the stable branch work exactly the same as beta ones, labels have
41+
just a slightly different name: `stable-nominated` identifies a PR to be
42+
discussed for a backport and `stable-accepted` is a PR accepted for
43+
backport. Declined stable nomination will have the `stable-nominated` label
44+
removed.
45+
46+
The `T-release` will decide on a case by case basis if a stable backport will
47+
warrant a point (.patch) release (f.e. release a `1.50.1` between `1.50` and `1.51`).
48+
49+
## Beta Backporting in `rust-lang/cargo`
3750

3851
The procedure for backporting fixes to Cargo is similar but slightly more
3952
extended than the `rust-lang/rust` repo's procedure. Currently there aren't
@@ -57,4 +70,3 @@ member has approved the backport to happen you're good to start sending PRs!
5770

5871
After that's all said and done the Cargo change is ready to get scheduled onto
5972
the beta release!
60-

0 commit comments

Comments
 (0)