Skip to content

Commit 1edc5e0

Browse files
authored
Merge PR #841: Editions: Add checklist on how to stabilize
2 parents fef1014 + 0f789c4 commit 1edc5e0

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/editions/edition-releases.md

+12
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,18 @@ This process may need to be repeated several times as problems are fixed and nee
151151
Beware that the process of running this and analyzing the reports may take a long time, depending on how many changes are in the Edition.
152152
The 2021 Edition took about a month, which involved analyzing hundreds of regressions, determining root causes, and re-running crater after fixes had been implemented.
153153

154+
## Stabilizing an edition
155+
156+
Once the edition team has approved the stabilization, actually stabilizing can be done by anyone. Stabilizing the edition involves getting the compiler, documentation, and all the tools updated:
157+
158+
- Stabilize in rustc. See [rustc stabilization instructions](https://rustc-dev-guide.rust-lang.org/guides/editions.html#stabilizing-an-edition).
159+
- Stabilize in cargo (after rustc update hits nightly). See [cargo stabilization instructions](https://doc.rust-lang.org/nightly/nightly-rustc/cargo/core/features/enum.Edition.html#stabilization-instructions).
160+
- Update the cargo submodule.
161+
- Update the edition guide to indicate it is stabilized. [Example for Rust 2024](https://github.com/rust-lang/edition-guide/pull/338).
162+
- Merge all pending edition PRs to the reference, and update it to default to the newly stabilized edition ([example for Rust 2024](https://github.com/rust-lang/reference/pull/1684)).
163+
- Update all the book submodules.
164+
- Publish a new version of mdbook that properly supports the new edition. [Example for Rust 2024](https://github.com/rust-lang/mdBook/pull/2495).
165+
154166
## Blog posts and announcements
155167

156168
It is highly encouraged for the Edition Project Group and the involved teams to communicate with everyone early and frequently.

0 commit comments

Comments
 (0)