Nix Release Process

# Nix release process ## Release artifacts The release process is intended to create the following for each release: * A Git tag * Binary tarballs in https://releases.nixos.org/?prefix=nix/ * Docker images * Closures in https://cache.nixos.org * (Optionally) Updated `fallback-paths.nix` in Nixpkgs * An updated manual on https://nix.dev/manual/nix/latest/ ## Creating a new release from the `master` branch * Make sure that the [Hydra `master` jobset](https://hydra.nixos.org/jobset/nix/master) succeeds. * In a checkout of the Nix repo, make sure you're on `master` and run `git pull`. * Compile a release notes to-do list by running ```console $ ./maintainers/release-notes-todo PREV_RELEASE HEAD ``` * Compile the release notes by running ```console $ export VERSION=X.YY $ git checkout -b release-notes $ export GITHUB_TOKEN=... $ ./maintainers/release-notes ``` where `X.YY` is *without* the patch level, e.g. `2.12` rather than ~~`2.12.0`~~. A commit is created. * Proof-read / edit / rearrange the release notes if needed. Breaking changes and highlights should go to the top. * Push. ```console $ git push --set-upstream $REMOTE release-notes ``` * Create a PR for `release-notes`. * Wait for the PR to be merged. * Create a branch for the release: ```console $ git checkout master $ git pull $ git checkout -b $VERSION-maintenance ``` * Mark the release as official: ```console $ sed -e 's/officialRelease = false;/officialRelease = true;/' -i flake.nix ``` This removes the link to `rl-next.md` from the manual and sets `officialRelease = true` in `flake.nix`. * Commit * Push the release branch: ```console $ git push --set-upstream origin $VERSION-maintenance ``` * Create a jobset for the release branch on Hydra as follows: * Go to the jobset of the previous release (e.g. https://hydra.nixos.org/jobset/nix/maintenance-2.11). * Select `Actions -> Clone this jobset`. * Set identifier to `maintenance-$VERSION`. * Set description to `$VERSION release branch`. * Set flake URL to `github:NixOS/nix/$VERSION-maintenance`. * Hit `Create jobset`. * Wait for the new jobset to evaluate and build. If impatient, go to the evaluation and select `Actions -> Bump builds to front of queue`. * When the jobset evaluation has succeeded building, take note of the evaluation ID (e.g. `1780832` in `https://hydra.nixos.org/eval/1780832`). * Tag the release and upload the release artifacts to [`releases.nixos.org`](https://releases.nixos.org/) and [Docker Hub](https://hub.docker.com/): ```console $ IS_LATEST=1 ./maintainers/upload-release.pl <EVAL-ID> ``` Note: `IS_LATEST=1` causes the `latest-release` branch to be force-updated. This is used by the `nixos.org` website to get the [latest Nix manual](https://nixos.org/manual/nixpkgs/unstable/). TODO: This script requires the right AWS credentials. Document. TODO: This script currently requires a `/home/eelco/Dev/nix-pristine`. TODO: trigger nixos.org netlify: https://docs.netlify.com/configure-builds/build-hooks/ * Prepare for the next point release by editing `.version` to e.g. ```console $ echo 2.12.1 > .version $ git commit -a -m 'Bump version' $ git push ``` Commit and push this to the maintenance branch. * Create a backport label. * Bump the version of `master`: ```console $ git checkout master

This document outlines the Nix release process, detailing the artifacts generated for each release, which include Git tags, binary tarballs, Docker images, closures, and an updated manual. It then provides a step-by-step guide for creating a new release from the `master` branch. This involves compiling and reviewing release notes, creating a dedicated maintenance branch, marking the release as official, configuring a new jobset on Hydra, and finally, tagging the release and uploading all necessary artifacts to various platforms like `releases.nixos.org` and Docker Hub. The process also includes preparing for subsequent point releases and bumping the version on `master`.