Skip to content

Commit an update to the CHaP flake input when the repo is deployed #1397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
neilmayhew wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Commit an update to the CHaP flake input when the repo is deployed #1397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93326cf
Modernize flake input instructions in README
neilmayhew Jun 29, 2026
15810f7
Commit an update to the CHaP flake input when the repo is deployed
neilmayhew Jun 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/CI.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,25 @@ jobs:
git update-ref "refs/heads/repo" "$commitId"
git push origin repo

- name: Install Nix
uses: DeterminateSystems/nix-installer-action@v22
with:
extra-conf: |
accept-flake-config = true

- name: Update CHaP flake input
run: |
# Restore the original checkout but leave the untracked _repo untouched
git restore --staged --worktree .
nix flake update CHaP
if git diff --quiet -- flake.lock; then
echo "flake.lock unchanged; skipping commit"
exit 0
fi
git add flake.lock
git commit -m 'Update CHaP flake input'
git push origin HEAD:${{ github.ref_name }}

- name: Setup Pages
uses: actions/configure-pages@v6

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ cabalProject {
To build some of the pacakges from CHaP, some C libraries will need to be installed. If you don't have those libraries installed cabal may pick an older library version that might not compile. An easy way to add those libraries is using the overlays provided by [iohk-nix](https://github.com/input-output-hk/iohk-nix). For example `plutus-core==1.21.0.0` depends on `libblst`, `haskell-nix-crypto` and `crypto` are the two overlays that would make it available during the build.

When you want to update the state of CHaP, you can simply update the flake input
(in the example above you would run `nix flake lock --update-input CHaP`).
(in the example above you would run `nix flake update CHaP`).

If you have CHaP configured correctly, then when you run `cabal build` from inside a `haskell.nix`
shell, you should not see any of the packages in CHaP being built by cabal.
Expand Down Expand Up @@ -280,7 +280,7 @@ Ideally, include the conditions under which we can deprecate it, e.g. "can depre

### How to update Hackage index used by CHaP

If one of your packages requires a newer version of a package published on Hackage, you will need to run: `nix flake lock --update-input hackage-nix`.
If one of your packages requires a newer version of a package published on Hackage, you will need to run: `nix flake update hackage-nix`.
[`hackage.nix`] is automatically updated from Hackage once per day.
If things still don't work because the version of the package is not available you'll need either wait for the automatic update or make a PR to [`hackage.nix`] first and then rerun the above command.

Expand Down