Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/typeable/stackage2nix
Generate Nix build instructions from a Stack file
https://github.com/typeable/stackage2nix
haskell nix nixpkgs stack stack2nix stackage
Last synced: about 10 hours ago
JSON representation
Generate Nix build instructions from a Stack file
- Host: GitHub
- URL: https://github.com/typeable/stackage2nix
- Owner: typeable
- License: bsd-3-clause
- Created: 2017-05-21T18:07:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-18T14:04:22.000Z (over 3 years ago)
- Last Synced: 2024-09-18T01:28:25.287Z (10 days ago)
- Topics: haskell, nix, nixpkgs, stack, stack2nix, stackage
- Language: Nix
- Size: 239 KB
- Stars: 49
- Watchers: 6
- Forks: 18
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# stackage2nix (DEPRECATED)
[](https://travis-ci.org/typeable/stackage2nix)
`stackage2nix` converts a Stack file into a Nix Haskell packages set.
# Create build derivation from stack.yaml
## Generate targets from stack.yaml only
```
stack exec -- stackage2nix .
```
Command creates file `default.nix` which overrides `haskell.packages.stackage`
packages set. You should use
[typeable/nixpkgs-stackage](https://github.com/typeable/nixpkgs-stackage) overlay that
adds LTS Stackage packages to Nixpkgs.
Build package with overlay installed:
```
nix-build -A stackage2nix
```
## Generate Stackage packages for the build
If you don't want to use Stackage overlay, stackage2nix can generate required
packages with `--with-stackage-closure` flag.
``` bash
stack exec -- stackage2nix \
--all-cabal-hashes /path/to/commercialhaskell/all-cabal-hashes \
--lts-haskell /path/to/fpco/lts-haskell \
--with-stackage-closure \
./stack.yaml
```
To generate Stackage packages, supply the `--all-cabal-hashes` flag
with the path to a local clone of
[all-cabal-hashes](https://github.com/commercialhaskell/all-cabal-hashes)
checked out on the `hackage` branch and supply the `--lts-haskell` flag
with the path to a local clone of
[lts-haskell](https://github.com/commercialhaskell/lts-haskell).
### stackage2nix wrapper
You can use stackage2nix wrapper from `nix` directory that adds required flags:
```
nix-env -i -f ./nix/stackage2nix
stackage2nix --with-stackage-closure ./stack.yaml
```
This command will produce `packages.nix` and `configuration-packages.nix`
Stackage packages and its override in `default.nix`
## Generate full Stackage
`--with-stackage` parameter generates full Stackage LTS in addition to the
targets from `stack.yaml`
```
nix-env -i -f ./nix/stackage2nix
stackage2nix --with-stackage ./stack.yaml
```
## Generate Stackage from LTS resolver
You can also generate only Stackage packages set from the resolver:
```
nix-env -i -f ./nix/stackage2nix
stackage2nix --resolver lts-10.0
```
This command will produce Stackage packages `packages.nix`, packages config
`configuration-packages.nix` and a Haskell packages set `default.nix`.
## Runtime dependencies
- `nix-env` is required to be on PATH by the
[distribution-nixpkgs](https://hackage.haskell.org/package/distribution-nixpkgs)
dependency
- `nix-prefetch-scripts` is required on PATH if you have git dependencies in
`stack.yaml`
## Override result derivation
Complex projects may require some extra customization.
Snippet `override.nix` below shows a minimal example of how to apply additional
overrides on top of Haskell packages set produced by `stackage2nix`.
``` nix
with import {};
with haskell.lib;
let haskellPackages = import ./. {};
in haskellPackages.override {
overrides = self: super: {
stackage2nix = disableSharedExecutables super.stackage2nix;
};
}
```
```
nix-build -A stackage2nix override.nix
```
For more complex overrides and detailed information on how to work with Haskell packages in Nix, see Nixpkgs manual [User’s Guide to the Haskell Infrastructure](http://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure)
## Tests
Integration tests that build stackage2nix form different yaml configs:
``` bash
STACKAGE_REPO= \
ALL_CABAL_HASHES= \
STACK_FILE=stack-ghc-7103.yaml \
./ci-stackage2nix
```