Merge pull request #1259 from emilazy/push-xztopxsynztu

Make release branches a thing
LnL7 · Jan 14, 2025 · bd92122 · bd92122
2 parents 6ace2f2 + e33d37c
commit bd92122
Show file tree

Hide file tree

Showing 9 changed files with 146 additions and 147 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -6,42 +6,42 @@ on:
       - master
 
 env:
-  CURRENT_STABLE_CHANNEL: nixpkgs-24.11-darwin
+  NIXPKGS_BRANCH: nixpkgs-unstable
+  NIX_DARWIN_BRANCH: master
+  NIX_VERSION: 2.24.11
 
 jobs:
-  test-stable:
-    runs-on: macos-13
-    steps:
-    - uses: actions/checkout@v4
-    - name: Install nix corresponding to latest stable channel
-      uses: cachix/install-nix-action@v30
-      with:
-        install_url: https://releases.nixos.org/nix/nix-2.18.8/install
-    - run: nix flake check --override-input nixpkgs nixpkgs/${{ env.CURRENT_STABLE_CHANNEL }}
+  # The `test-stable` and `install-against-stable` job names are
+  # load‐bearing, despite their inaccuracy on the unstable branch, as
+  # they are set as required checks in the repository configuration,
+  # which only repository admins can change.
+  #
+  # TODO: Change them once the repository configuration is updated.
 
-  test-unstable:
+  test-stable:
     runs-on: macos-13
     steps:
     - uses: actions/checkout@v4
-    - name: Install nix from current unstable channel
+    - name: Install Nix
       uses: cachix/install-nix-action@v30
       with:
-        install_url: https://releases.nixos.org/nix/nix-2.24.9/install
-    - run: nix flake check --override-input nixpkgs nixpkgs/nixpkgs-unstable
+        install_url: https://releases.nixos.org/nix/nix-${{ env.NIX_VERSION }}/install
+    - run: nix flake check --override-input nixpkgs nixpkgs/${{ env.NIXPKGS_BRANCH }}
 
   install-against-stable:
     runs-on: macos-13
+    timeout-minutes: 30
     steps:
     - uses: actions/checkout@v4
-    - name: Install nix corresponding to latest stable channel
+    - name: Install Nix
       uses: cachix/install-nix-action@v30
       with:
-        install_url: https://releases.nixos.org/nix/nix-2.18.8/install
-        nix_path: nixpkgs=channel:${{ env.CURRENT_STABLE_CHANNEL }}
+        install_url: https://releases.nixos.org/nix/nix-${{ env.NIX_VERSION }}/install
+        nix_path: nixpkgs=channel:${{ env.NIXPKGS_BRANCH }}
     - name: Install channels
       run: |
-        nix-channel --add https://github.com/LnL7/nix-darwin/archive/master.tar.gz darwin
-        nix-channel --add https://nixos.org/channels/${{ env.CURRENT_STABLE_CHANNEL }} nixpkgs
+        nix-channel --add https://github.com/LnL7/nix-darwin/archive/${{ env.NIX_DARWIN_BRANCH }}.tar.gz darwin
+        nix-channel --add https://nixos.org/channels/${{ env.NIXPKGS_BRANCH }} nixpkgs
         nix-channel --update
     - name: Install nix-darwin
       run: |
@@ -75,116 +75,20 @@ jobs:
         # `cachix/install-nix-action` but not by our default config above
         nix run .#darwin-uninstaller \
           --extra-experimental-features "nix-command flakes" \
-          --override-input nixpkgs nixpkgs/${{ env.CURRENT_STABLE_CHANNEL }}
+          --override-input nixpkgs nixpkgs/${{ env.NIXPKGS_BRANCH }}
         nix run .#darwin-uninstaller.tests.uninstaller \
           --extra-experimental-features "nix-command flakes" \
-          --override-input nixpkgs nixpkgs/${{ env.CURRENT_STABLE_CHANNEL }}
-
-  install-against-unstable:
-    runs-on: macos-13
-    timeout-minutes: 30
-    steps:
-    - uses: actions/checkout@v4
-    - name: Install nix from current unstable channel
-      uses: cachix/install-nix-action@v30
-      with:
-        install_url: https://releases.nixos.org/nix/nix-2.24.9/install
-        nix_path: nixpkgs=channel:nixpkgs-unstable
-    - name: Install channels
-      run: |
-        nix-channel --add https://github.com/LnL7/nix-darwin/archive/master.tar.gz darwin
-        nix-channel --add https://nixos.org/channels/nixpkgs-unstable nixpkgs
-        nix-channel --update
-    - name: Install nix-darwin
-      run: |
-        export NIX_PATH=$HOME/.nix-defexpr/channels
-
-        mkdir -p ~/.config/nix-darwin
-        cp modules/examples/simple.nix ~/.config/nix-darwin/configuration.nix
-
-        nixConfHash=$(shasum -a 256 /etc/nix/nix.conf | cut -d ' ' -f 1)
-        /usr/bin/sed -i.bak \
-          "s/# programs.fish.enable = true;/nix.settings.access-tokens = [ \"github.com=\${{ secrets.GITHUB_TOKEN }}\" ]; environment.etc.\"nix\/nix.conf\".knownSha256Hashes = [ \"$nixConfHash\" ];/" \
-          ~/.config/nix-darwin/configuration.nix
-
-        nix run .#darwin-rebuild \
-          -- switch \
-          -I darwin-config=$HOME/.config/nix-darwin/configuration.nix
-    - name: Switch to new configuration
-      run: |
-        . /etc/bashrc
-
-        /usr/bin/sed -i.bak \
-          "s/pkgs.vim/pkgs.hello/" \
-          ~/.config/nix-darwin/configuration.nix
-
-        darwin-rebuild switch -I darwin=.
-
-        hello
-    - name: Test uninstallation of nix-darwin
-      run: |
-        # We need to specify `--extra-experimental-features` because `experimental-features` is set by
-        # `cachix/install-nix-action` but not by our default config above
-        nix run .#darwin-uninstaller \
-           --extra-experimental-features "nix-command flakes" \
-           --override-input nixpkgs nixpkgs/nixpkgs-unstable
-        nix run .#darwin-uninstaller.tests.uninstaller \
-           --extra-experimental-features "nix-command flakes" \
-           --override-input nixpkgs nixpkgs/nixpkgs-unstable
-
-  install-flake-against-stable:
-    runs-on: macos-13
-    steps:
-    - uses: actions/checkout@v4
-    - name: Install nix version corresponding to latest stable channel
-      uses: cachix/install-nix-action@v30
-      with:
-        install_url: https://releases.nixos.org/nix/nix-2.18.8/install
-    - name: Install nix-darwin
-      run: |
-        mkdir -p ~/.config/nix-darwin
-        darwin=$(pwd)
-        pushd ~/.config/nix-darwin
-          nix flake init -t $darwin
-          nixConfHash=$(shasum -a 256 /etc/nix/nix.conf | cut -d ' ' -f 1)
-          /usr/bin/sed -i.bak \
-            "s/# programs.fish.enable = true;/nix.settings.access-tokens = [ \"github.com=\${{ secrets.GITHUB_TOKEN }}\" ]; environment.etc.\"nix\/nix.conf\".knownSha256Hashes = [ \"$nixConfHash\" ];/" \
-            flake.nix
-          /usr/bin/sed -i.bak \
-            's/nixpkgs.hostPlatform = "aarch64-darwin";/nixpkgs.hostPlatform = "'$(nix eval --expr builtins.currentSystem --impure --raw)'";/' \
-            flake.nix
-        popd
-        nix run .#darwin-rebuild -- \
-          switch --flake ~/.config/nix-darwin#simple \
-          --override-input nix-darwin . \
-          --override-input nixpkgs nixpkgs/${{ env.CURRENT_STABLE_CHANNEL }}
-    - name: Switch to new configuration
-      run: |
-        . /etc/bashrc
-
-        /usr/bin/sed -i.bak \
-          "s/pkgs.vim/pkgs.hello/" \
-          ~/.config/nix-darwin/flake.nix
-
-        darwin-rebuild switch --flake ~/.config/nix-darwin#simple \
-          --override-input nix-darwin . \
-          --override-input nixpkgs nixpkgs/${{ env.CURRENT_STABLE_CHANNEL }}
-
-        hello
-    - name: Test uninstallation of nix-darwin
-      run: |
-        nix run .#darwin-uninstaller --override-input nixpkgs nixpkgs/${{ env.CURRENT_STABLE_CHANNEL }}
-        nix run .#darwin-uninstaller.tests.uninstaller --override-input nixpkgs nixpkgs/${{ env.CURRENT_STABLE_CHANNEL }}
+          --override-input nixpkgs nixpkgs/${{ env.NIXPKGS_BRANCH }}
 
-  install-flake-against-unstable:
+  install-flake:
     runs-on: macos-13
     timeout-minutes: 30
     steps:
     - uses: actions/checkout@v4
-    - name: Install nix from current unstable channel
+    - name: Install Nix
       uses: cachix/install-nix-action@v30
       with:
-        install_url: https://releases.nixos.org/nix/nix-2.24.9/install
+        install_url: https://releases.nixos.org/nix/nix-${{ env.NIX_VERSION }}/install
     - name: Install nix-darwin
       run: |
         mkdir -p ~/.config/nix-darwin
@@ -202,7 +106,7 @@ jobs:
         nix run .#darwin-rebuild -- \
           switch --flake ~/.config/nix-darwin#simple \
           --override-input nix-darwin . \
-          --override-input nixpkgs nixpkgs/nixpkgs-unstable
+          --override-input nixpkgs nixpkgs/${{ env.NIXPKGS_BRANCH }}
     - name: Switch to new configuration
       run: |
         . /etc/bashrc
@@ -213,10 +117,10 @@ jobs:
 
         darwin-rebuild switch --flake ~/.config/nix-darwin#simple \
           --override-input nix-darwin . \
-          --override-input nixpkgs nixpkgs/nixpkgs-unstable
+          --override-input nixpkgs nixpkgs/${{ env.NIXPKGS_BRANCH }}
 
         hello
     - name: Test uninstallation of nix-darwin
       run: |
-        nix run .#darwin-uninstaller --override-input nixpkgs nixpkgs/nixpkgs-unstable
-        nix run .#darwin-uninstaller.tests.uninstaller --override-input nixpkgs nixpkgs/nixpkgs-unstable
+        nix run .#darwin-uninstaller --override-input nixpkgs nixpkgs/${{ env.NIXPKGS_BRANCH }}
+        nix run .#darwin-uninstaller.tests.uninstaller --override-input nixpkgs nixpkgs/${{ env.NIXPKGS_BRANCH }}
diff --git a/README.md b/README.md
@@ -38,7 +38,12 @@ If you don't have an existing `configuration.nix`, you can run the following com
 ```bash
 mkdir -p ~/.config/nix-darwin
 cd ~/.config/nix-darwin
-nix flake init -t nix-darwin
+
+# To use Nixpkgs unstable:
+nix flake init -t nix-darwin/master
+# To use Nixpkgs 24.11:
+nix flake init -t nix-darwin/nix-darwin-24.11
+
 sed -i '' "s/simple/$(scutil --get LocalHostName)/" flake.nix
 ```
 
@@ -57,8 +62,10 @@ Add the following to `flake.nix` in the same folder as `configuration.nix`:
   description = "John's darwin system";
 
   inputs = {
-    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-24.11-darwin";
-    nix-darwin.url = "github:LnL7/nix-darwin";
+    # Use `github:NixOS/nixpkgs/nixpkgs-24.11-darwin` to use Nixpkgs 24.11.
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    # Use `github:LnL7/nix-darwin/nix-darwin-24.11` to use Nixpkgs 24.11.
+    nix-darwin.url = "github:LnL7/nix-darwin/master";
     nix-darwin.inputs.nixpkgs.follows = "nixpkgs";
   };
 
@@ -122,16 +129,24 @@ Copy the [simple](./modules/examples/simple.nix) example to `~/.config/nix-darwi
 ### Step 2. Adding `nix-darwin` channel
 
 ```bash
-nix-channel --add https://github.com/LnL7/nix-darwin/archive/master.tar.gz darwin
-nix-channel --update
+# If you use Nixpkgs unstable (the default):
+sudo nix-channel --add https://github.com/LnL7/nix-darwin/archive/master.tar.gz darwin
+# If you use Nixpkgs 24.11:
+sudo nix-channel --add https://github.com/LnL7/nix-darwin/archive/nix-darwin-24.11.tar.gz darwin
+
+sudo nix-channel --update
 ```
 
 ### Step 3. Installing `nix-darwin`
 
 To install `nix-darwin`, you can just run `darwin-rebuild switch` to install nix-darwin. As `darwin-rebuild` won't be installed in your `PATH` yet, you can use the following command:
 
 ```bash
+# If you use Nixpkgs unstable (the default):
 nix-build https://github.com/LnL7/nix-darwin/archive/master.tar.gz -A darwin-rebuild
+# If you use Nixpkgs 24.11:
+nix-build https://github.com/LnL7/nix-darwin/archive/nix-darwin-24.11.tar.gz -A darwin-rebuild
+
 ./result/bin/darwin-rebuild switch -I darwin-config=$HOME/.config/nix-darwin/configuration.nix
 ```
 
@@ -145,10 +160,10 @@ darwin-rebuild switch
 
 ### Step 5. Updating `nix-darwin`
 
-You can update `nix-darwin` using the following command:
+You can update Nixpkgs and `nix-darwin` using the following command:
 
 ```bash
-nix-channel --update darwin
+sudo nix-channel --update
 ```
 </details>
 

diff --git a/eval-config.nix b/eval-config.nix
@@ -1,10 +1,72 @@
+let
+  nixDarwinVersion = builtins.fromJSON (builtins.readFile ./version.json);
+
+  checkRelease = lib:
+    # Avoid breaking configurations when the unstable Nixpkgs version
+    # rolls over.
+    #
+    # TODO: Something more refined than this would be ideal, as this
+    # still means you could be using unstable nix-darwin 25.05 with
+    # Nixpkgs 26.05, which would be unfortunate.
+    if nixDarwinVersion.isReleaseBranch then
+      lib.trivial.release == nixDarwinVersion.release
+    else
+      lib.versionAtLeast lib.trivial.release nixDarwinVersion.release;
+in
+
 { lib
 , modules
 , baseModules ? import ./modules/module-list.nix
 , specialArgs ? { }
 , check ? true
+, enableNixpkgsReleaseCheck ? true
 }@args:
 
+assert enableNixpkgsReleaseCheck -> checkRelease lib || throw ''
+
+  nix-darwin now uses release branches that correspond to Nixpkgs releases.
+  The nix-darwin and Nixpkgs branches in use must match, but you are currently
+  using nix-darwin ${nixDarwinVersion.release} with Nixpkgs ${lib.trivial.release}.
+
+  On macOS, you should use either the `nixpkgs-unstable` or
+  `nixpkgs-YY.MM-darwin` branches of Nixpkgs. These correspond to the
+  `master` and `nix-darwin-YY.MM` branches of nix-darwin, respectively. Check
+  <https://status.nixos.org/> for the currently supported Nixpkgs releases.
+
+  If you’re using flakes, make sure your inputs look like this:
+
+      inputs = {
+        nixpkgs.url = "github:NixOS/nixpkgs/NIXPKGS-BRANCH";
+        nix-darwin.url = "github:LnL7/nix-darwin/NIX-DARWIN-BRANCH";
+        nix-darwin.inputs.nixpkgs.follows = "nixpkgs";
+        # …
+      };
+
+  If you’re using channels, you can check your current channels with:
+
+      $ sudo nix-channel --list
+      nixpkgs https://nixos.org/channels/NIXPKGS-BRANCH
+      darwin https://github.com/LnL7/nix-darwin/archive/NIX-DARWIN-BRANCH.tar.gz
+      …
+      $ nix-channel --list
+      …
+
+  If `darwin` or `nixpkgs` are present in `nix-channel --list` (without
+  `sudo`), you should delete them with `nix-channel --remove NAME`. These can
+  contribute to version mismatch problems.
+
+  You can then fix your channels like this:
+
+      $ sudo nix-channel --add https://nixos.org/channels/NIXPKGS-BRANCH nixpkgs
+      $ sudo nix-channel --add https://github.com/LnL7/nix-darwin/archive/NIX-DARWIN-BRANCH.tar.gz darwin
+      $ sudo nix-channel --update
+
+  After that, activating your system again should work correctly. If it
+  doesn’t, please open an issue at
+  <https://github.com/LnL7/nix-darwin/issues/new> and include as much
+  information as possible.
+'';
+
 let
   argsModule = {
     _file = ./eval-config.nix;

diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -1,6 +1,10 @@
 {
   description = "A collection of darwin modules";
 
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+  };
+
   outputs = { self, nixpkgs }: let
     forAllSystems = nixpkgs.lib.genAttrs [ "aarch64-darwin" "x86_64-darwin" "aarch64-linux" "x86_64-linux" ];
     forDarwinSystems = nixpkgs.lib.genAttrs [ "aarch64-darwin" "x86_64-darwin" ];

diff --git a/modules/examples/flake/flake.nix b/modules/examples/flake/flake.nix
@@ -3,7 +3,7 @@
 
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
-    nix-darwin.url = "github:LnL7/nix-darwin";
+    nix-darwin.url = "github:LnL7/nix-darwin/master";
     nix-darwin.inputs.nixpkgs.follows = "nixpkgs";
   };