From 6a901781164d0f0c1bd5c20b6aa482a058fb7b8d Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Tue, 30 Sep 2025 15:58:16 -0700 Subject: [PATCH] Add a description of how the reference is published This adds a description of how the reference gets published. Closes https://github.com/rust-lang/reference/issues/38 --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86804ff33..1db891c78 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # The Rust Language Reference -This document is the primary reference for the Rust programming -language. +This document is the primary reference for the Rust programming language. ## Contributor docs @@ -81,3 +80,15 @@ There are several different kinds of tests you can run (these are enforced on CI * `cargo xtask style-check`: This will validate some style checks (see [authoring guide](docs/authoring.md)). * `cargo xtask linkcheck`: This will validate that markdown links aren't broken. * `cargo xtask test-all`: Runs all tests. + +## How is this published? + +The process for getting the reference content into a [Rust release](https://doc.rust-lang.org/reference/#rust-releases) and on the website is: + +1. Changes are merged to this repository. +2. [Triagebot](https://forge.rust-lang.org/triagebot/doc-updates.html) will automatically synchronize this repository to [rust-lang/rust]. This happens every other week. The reference is tracked in [rust-lang/rust] as a [submodule](https://github.com/rust-lang/rust/tree/master/src/doc). + - This will open a PR on [rust-lang/rust] which needs to be merged, and that can take up to several days. +3. At midnight UTC, whatever is on the default branch of [rust-lang/rust] will be a part of that nightly release, and will be published after a few hours to . +4. Following Rust's [release process](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html), every 6 weeks, nightly will be promoted to beta (), and then 6 weeks after that it will be promoted to stable (). + +[rust-lang/rust]: https://github.com/rust-lang/rust/