Skip to content

Commit 0b054af

Browse files
committed
docs: document Nix lockfile sync for dependency updates
1 parent e1ccf6e commit 0b054af

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,24 @@ bun run check:prebuilt-pack
8787
bun run publish:prebuilt:npm -- --dry-run
8888
```
8989

90+
## Updating dependencies
91+
92+
After changing JavaScript or Bun dependencies, regenerate the Nix dependency lockfile so CI stays green:
93+
94+
```bash
95+
bun install
96+
bun run nix:update-lock
97+
git add bun.lock nix/bun.lock.nix package.json
98+
```
99+
100+
The `nix:update-lock` script requires a one-time [Nix install](https://nixos.org/download/):
101+
102+
```bash
103+
curl -L https://nixos.org/nix/install | sh
104+
```
105+
106+
If you don't have Nix installed, CI will catch the drift and a maintainer can push the regenerated lockfile as a follow-up commit.
107+
90108
## Validation expectations
91109

92110
- Rendering changes: run `bun run typecheck`, `bun test`, `bun run test:tty-smoke`, and do one real TTY smoke run on an actual diff.

0 commit comments

Comments
 (0)