The Rust Release Process
Here’s how Rust is currently released:
Update books (T-6 days, Friday)
From within the repo:
$ cd src/doc/book $ git fetch origin $ git reset --hard origin/master $ cd ../rust-by-example $ git fetch origin $ git reset --hard origin/master $ cd ../reference $ git fetch origin $ git reset --hard origin/master $ cd ../nomicon $ git fetch origin $ git reset --hard origin/master $ cd ../../.. $ git add . $ git commit -m "update books for next release"
This can be done a day earlier too, if you’d like: the books are only tested fully once they’re in this repo, and so updating them may cause tests to fail. If they do, you need to send in a PR to the right book, ping @steveklabnik to get a quick merge, and then update that particular book again to fix it. This should be relatively rare.
Promote beta to stable (T-3 days, Monday)
Promote beta to stable. Temporarily turn off GitHub branch protection for the
stable branch in rust-lang/rust repo. In your local Rust repo:
$ git fetch rust-lang $ git push rust-lang rust-lang/beta:stable -f
Re-enable branch protection for the
stable branch. Send a PR to
rust-lang/rust on the stable branch making the following changes:
- Update the cargo submodule to the latest of the branch for this rustc version.
Cargo branches are named
- Update the rls submodule to the latest of the branch for this rustc version as with Cargo, only if the RLS has such a branch (currently it doesn’t).
Once the PR is sent, r+ it and give it a high
The stable build will not deploy automatically to prod. The rust-central-station repository is configured to upload to dev every hour if it detects a change. You should be able to browse changes in dev.
As soon as this build is done post a message to irlo asking for testing. The index is https://dev-static-rust-lang-org.s3.amazonaws.com/dist/2015-09-17/index.html and our URL is then https://dev-static.rust-lang.org/dist/2015-09-17/index.html.
Test rustup with
RUSTUP_DIST_SERVER=https://dev-static.rust-lang.org rustup update stable
Promote master to beta (T-2 days, Tuesday)
Branch a rust-lang/cargo commit for the new beta:
$ cd cargo $ git fetch rust-lang $ git push rust-lang rust-lang/master:rust-1.14.0
In theory one day we’ll do the same for rust-lang-nursery/rls, but for now we haven’t done this yet.
Temporarily disable banch protection on GitHub for the
beta branch of the Rust
repo. Promote rust-lang/rust’s master branch to beta as with yesterday:
$ git fetch rust-lang $ git push rust-lang rust-lang/master:beta -f
Re-enable branch protection on GitHub. Send a PR to the freshly created beta branch of rust-lang/rust which:
- Update src/stage0.txt
dateto “YYYY-MM-DD” where the date is the archive date the stable build was uploaded
rustcto “X.Y.Z” where that’s the version of rustc you just build
cargoto “A.B.C” where it’s Cargo’s version. That’s typically “0.(Y+1).0” wrt the rustc version.
- Update src/ci/run.sh to pass “–release-channel=beta”.
- Update the cargo submodule to the head of the versioned branch
Note that you probably don’t want to update the RLS if it’s working, but if it’s not working beta won’t land and it’ll need to get updated. After this PR merges (through @bors) the beta should be automatically released.
Master bootstrap update (T-1 day, Wednesday)
Write a new blog post and update rust-www. Submit PRs for tomorrow.
Send a PR to the master branch to:
- modify src/stage0.txt to bootstrap from yesterday’s beta
- modify src/bootstrap/channel.rs with the new version number
- Update the cargo submodule to the master branch
In theory update the RLS submodule as well, but it’s pretty susceptible to breakage so I’d probably avoid that for now.
Release day (Thursday)
Decide on a time to do the release, T.
T-30m - This is on rust-central-station:
docker exec -d -it rcs bash -c \ 'promote-release /tmp/stable stable /data/secrets.toml 2>&1 | logger --tag release-stable-realz'
That’ll, in the background, schedule the
promote-releasebinary to run on the production secrets (not the dev secrets). That’ll sign everything, upload it, update the html index pages, and invalidate the CDN. Note that this takes about 30 minutes right now. Logs are in
T-20m - Merge the website. Travis may have a big backlog, cancel rust-lang/rust PR builds or other builds until this build is scheduled.
T-10m - Locally, tag the new release and upload it. Use “x.y.z release” as the commit message.
$ git tag -u FA1BE5FE 1.3.0 $COMMIT_SHA $ git push rust-lang 1.3.0
After this Update thanks.rust-lang.org.
T-5m - Merge blog post.
T - Tweet and post everything!
T+5m - Tag Cargo the same way as rust-lang/rust and then run
cargo publishfor the tag you just created.
Also tag RLS the same way and then run
cargo publishfor the tag you just created.
T+1hr Send a PR to the beta branch to comment out
dev: 1again and update the date to download from (modifying
Bask in your success.
Update dependencies (T+1 day, Friday)
In the repo:
$ cd src $ cargo update
The very ambitious can use https://crates.io/crates/cargo-outdated and update through breaking changes.