Skip to content

Commit 3294d19

Browse files
add update instructions
1 parent 1075103 commit 3294d19

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,23 @@ Adapted from the [Contributor Covenant] and [The Carpentries Code of Conduct]:
2222
[Contributor Covenant]: https://github.com/EthicalSource/contributor_covenant/blob/cd7fcf684249786b7f7d47ba49c23a6bcb3233eb/content/version/2/1/code_of_conduct.md
2323
[The Carpentries Code of Conduct]: https://github.com/carpentries/docs.carpentries.org/blob/4691971d9f49544054410334140a4fd391a738da/topic_folders/policies/code-of-conduct.md
2424

25+
## Updating reference manuals
26+
27+
With the current setup, the Nix manual hosted on nix.dev does not get updated automatically with new releases.
28+
The following manual steps are required:
29+
30+
- Update the inputs to use the latest versions of the Nix release branches with `nix flake lock`
31+
- Make sure Nix can be fetched from the cache, otherwise it has to be rebuild.
32+
If it doesn't, find the latest commit that is [built by Hydra](https://hydra.nixos.org/project/nix).
33+
- On each new Nix release, update the latest version in [`flake.nix`](./flake.nix) and [`source/reference/nix-manual.md`](./source/reference/nix-manual.md).
34+
- If Nixpkgs unstable or a NixOS stable release adopt a new version of Nix, update the corresponding references here.
35+
36+
Also update URLs to the the Nix manual to the version used by Nixpkgs unstable.
37+
For example, if one wants to move from 2.18 to 2.19:
38+
```bash
39+
sed -i 's#https://nix.dev/manual/nix/2.18/#https://nix.dev/manual/nix/2.19/#g' $(ls **/*.md)
40+
```
41+
2542
## What you can do
2643

2744
### You want to learn and use Nix?

0 commit comments

Comments
 (0)