@@ -16,11 +16,8 @@ The following checklist guides you through the complete process in more detail.
1616## Upgrade the pinned version of ` nixpkgs `
1717
1818The pinned version of [ ` nixpkgs ` ] ( https://github.com/NixOS/nixpkgs ) is defined
19- in [ ` nix/nixpkgs-version.nix ` ] ( nixpkgs-version.nix ) . The pin refers directly to
20- a GitHub tarball for the given revision, which is more efficient than pulling
21- the complete Git repository. To upgrade it to the current ` main ` of
22- ` nixpkgs ` , you can use a small utility script defined in
23- [ ` nix/nixpkgs-update.nix ` ] ( nixpkgs-update.nix ) :
19+ in [ ` flake.nix ` ] ( ../flake.nix ) . To upgrade it, you can use a small utility
20+ script defined in [ ` nix/tools/nixpkgsTools.nix ` ] ( tools/nixpkgsTools.nix ) :
2421
2522``` bash
2623# From the root of the repository, enter nix-shell
@@ -30,21 +27,12 @@ nix-shell
3027postgrest-nixpkgs-upgrade
3128
3229# Exit the nix-shell with Ctrl-d
33-
3430```
3531
3632## Review overlays
3733
3834Check whether the individual [ overlays] ( overlays ) are still required.
3935
40- ## Check if patches are still required and update them as needed
41-
42- We track a number of PostgREST-specific patches in [ ` nix/patches ` ] ( patches ) .
43- Check whether the pull-requests/issues linked in the
44- [ ` default.nix ` ] ( patches/default.nix ) have progressed and remove/modify the
45- patches if they did. If conflicting changes occurred, you might have to rebase
46- the respective patches.
47-
4836## Build everything
4937
5038Using the PostgREST binary Nix cache is recommended. Install
@@ -58,25 +46,19 @@ errors, this is probably due to one of our patches. Try to fix them and re-run
5846
5947## Update the PostgREST binary cache
6048
61- If you have access to the PostgREST cachix signing key , you can push the
49+ If you have access to the PostgREST cachix project , you can push the
6250artifacts that you built locally to the binary cache. This will accelerate the
6351CI builds and tests, sometimes dramatically. This might sometimes even be
6452required to avoid build timeouts in CI.
6553
66- You'll need to set the ` CACHIX_SIGNING_KEY ` before proceeding, e.g. by creating
67- a file containing ` export CACHIX_SIGNING_KEY=... ` and sourcing that file, which
68- avoids having the secret in your shell history.
54+ You'll need to login with your token with ` cachix authtoken <token> ` .
6955
7056To push all new artifacts to Cachix, run:
7157
7258```
73- nix-store -qR --include-outputs $$(nix-instantiate) | cachix push postgrest
74-
75- # Or, equivalently
7659nix-shell --run postgrest-push-cachix
77-
7860```
7961
80- The ` nix-store ` command will query the nix-store to list all dependencies and
81- build artifacts of PostgREST. The ` cachix ` command will efficiently push
62+ The ` postgrest-push-cachix ` command will query the nix-store to list all
63+ dependencies and build artifacts of PostgREST. It will then push
8264everything that is not yet cached to the binary cache.
0 commit comments