Skip to content

Commit

Permalink
Update dependencies and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Sukant Hajra committed Dec 28, 2024
1 parent 93f3c6b commit 556cdbc
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
- uses: cachix/install-nix-action@v30
with:
# DESIGN: matching current in NixOS 24.11
install_url: https://releases.nixos.org/nix/nix-2.24.10/install
install_url: https://releases.nixos.org/nix/nix-2.24.11/install
- uses: cachix/cachix-action@v15
with:
name: shajra
Expand Down
2 changes: 1 addition & 1 deletion doc/internal/params.el
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
(run-target-short . "org2gfm")
;; run-target-long will always prefix "bin/"
(nix-latest . "2.25.3")
(nix-stable . "2.24.10")
(nix-stable . "2.24.11")
(nixos-latest . "24.11")
(platforms . "\n\
- Linux on x86-64 machines\n\
Expand Down
4 changes: 2 additions & 2 deletions doc/nix-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ Hopefully, this alleviates any worry about installing a complex program on your

> **<span class="underline">NOTE:</span>** You don't need this step if you're running NixOS, which comes with Nix baked in.
Though the latest version of Nix is Nix 2.25.3, we'll be installing the version that the last release of NixOS (24.11) uses, specifically Nix 2.24.10. As discussed in the included [introduction to Nix](nix-introduction.md), this version is considered stable by the Nix community.
Though the latest version of Nix is Nix 2.25.3, we'll be installing the version that the last release of NixOS (24.11) uses, specifically Nix 2.24.11. As discussed in the included [introduction to Nix](nix-introduction.md), this version is considered stable by the Nix community.

The following command calls the official installation script for the recommended version of Nix. Note, this script will require `sudo` access.

```bash
sh <(curl -L https://releases.nixos.org/nix/nix-2.24.10/install) --daemon
sh <(curl -L https://releases.nixos.org/nix/nix-2.24.11/install) --daemon
```

The `--daemon` switch installs Nix in the multi-user mode, which is generally recommended (single-user installation with `--no-daemon` instead is recommended for WSL). The script reports everything it does and touches.
Expand Down
6 changes: 3 additions & 3 deletions doc/nix-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,11 @@ However, if industrial users move to flakes to address these problems, we have t

### Nix quick releases compete with stability<a id="sec-4-2-3"></a>

The latest major version of the Nix package manager is currently Nix 2.25.3, but NixOS 24.11, the latest stable release of NixOS, uses Nix 2.24.10. NixOS is the primary way the Nix package manager gets used in the field. Far fewer users install Nix as a package manager atop another operating system. From a community perspective it makes sense to consider Nix 2.24.10 the stable release of the package manager. This version gets the most scrutiny and critical bug fixes.
The latest major version of the Nix package manager is currently Nix 2.25.3, but NixOS 24.11, the latest stable release of NixOS, uses Nix 2.24.11. NixOS is the primary way the Nix package manager gets used in the field. Far fewer users install Nix as a package manager atop another operating system. From a community perspective it makes sense to consider Nix 2.24.11 the stable release of the package manager. This version gets the most scrutiny and critical bug fixes.

As mentioned above, there are strong reasons to use still-experimental features, particularly flakes. However, APIs and calculated hashes change too frequently in experimental features from version-to-version. By sticking with the version used in NixOS, we get less breaking changes. For example, the [flake.lock](../flake.lock) file included with this project has calculated hashes for dependencies. These hashes were computed with Nix 2.24.10, and could change with later versions.
As mentioned above, there are strong reasons to use still-experimental features, particularly flakes. However, APIs and calculated hashes change too frequently in experimental features from version-to-version. By sticking with the version used in NixOS, we get less breaking changes. For example, the [flake.lock](../flake.lock) file included with this project has calculated hashes for dependencies. These hashes were computed with Nix 2.24.11, and could change with later versions.

For these reasons, the [installation guide included with this project](nix-installation.md) recommends installing Nix 2.24.10, rather than the latest official release.
For these reasons, the [installation guide included with this project](nix-installation.md) recommends installing Nix 2.24.11, rather than the latest official release.

## A few gaps in determinism<a id="sec-4-3"></a>

Expand Down
24 changes: 12 additions & 12 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 556cdbc

Please sign in to comment.