Skip to content
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.

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

Use the nix flake to provide formal-ledger-specifications SRP #4912

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

carlostome
Copy link

@carlostome carlostome commented Mar 4, 2025

Description

This PR removes the need for an external tool, such as nix-prefetch-git, when updating the SRP that points to the formal ledger specifications repo.

In addition it removes duplication of instructions in cabal.project and CONTRIBUTING.md.

Feel free to just ignore part or all of this PR. I came across this small improvement (IMO) while doing #4910.

Checklist

  • Commits in meaningful sequence and with useful messages.
  • Tests added or updated when needed.
  • CHANGELOG.md files updated for packages with externally visible changes.
    NOTE: New section is never added with the code changes. (See RELEASING.md).
  • Versions updated in .cabal and CHANGELOG.md files when necessary, according to the
    versioning process.
  • Version bounds in .cabal files updated when necessary.
    NOTE: If bounds change in a cabal file, that package itself must have a version increase. (See RELEASING.md).
  • Code formatted (use scripts/fourmolize.sh).
  • Cabal files formatted (use scripts/cabal-format.sh).
  • hie.yaml updated (use scripts/gen-hie.sh).
  • Self-reviewed the diff.

@carlostome carlostome requested a review from a team as a code owner March 4, 2025 07:37
* alternatively, use a tool like `nix-prefetch-git` to fetch and compute the `sha256`
```shell
nix flake update formal-ledger-specifications --override-input formal-ledger-specifications github:IntersectMBO/formal-ledger-specifications/SHA
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, so much easier! Had no idea it's possible like this.

I think it would be good to add this alternative instead of completely replacing the old instructions - even though it's more noisy, but it would be good to leave them for non-nix users.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel the instructions were already nix specific (since after all is haskell.nix that is using the commented out sha256 field).

For non nix users I'd add a comment saying that it is ok to skip this step.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants