Skip to content

Commit 7ff3d1a

Browse files
committed
doc: Add note about hackage and stackage update scripts
1 parent 0a4a92a commit 7ff3d1a

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

doc/maintainer-scripts.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Updating Hackage and Stackage Nix expressions
2+
3+
The [`hackage.nix`](https://github.com/input-output-hk/hackage.nix)
4+
and [`stackage.nix`](https://github.com/input-output-hk/stackage.nix)
5+
repos and corresponding files `hackage-src.json` and
6+
`stackage-src.json` will be regularly and automatically updated using
7+
scripts in this repo.
8+
9+
To run the updater scripts manually, use:
10+
11+
nix-build -A maintainer-scripts.update-hackage -o update-hackage.sh
12+
./update-hackage.sh
13+
14+
nix-build -A maintainer-scripts.update-stackage -o update-stackage.sh
15+
./update-stackage.sh
16+
17+
The scripts will clone the repo, generate the latest data, then
18+
attempt to push back to the repo and update the source JSON file.

0 commit comments

Comments
 (0)