stack2nix: Convert stack.yaml files into Nix build instructions.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

Exposed modules use unallocated top-level names: Stack2nix

Convert stack.yaml files into Nix build instructions.

[Skip to Readme]

Properties

Versions	0.1.1.0, 0.1.1.0, 0.1.2.0, 0.1.3.0, 0.2, 0.2.1, 0.2.2, 0.2.3
Change log	None available
Dependencies	async, base (>=4.9 && <4.10), bytestring, Cabal, containers, data-fix, directory, filepath, Glob, hnix (>=0.3.4), monad-parallel, optparse-applicative, process, SafeSemaphore, stack2nix, temporary, text, yaml [details]
License	MIT
Author	Jacob Mitchell
Maintainer	jacob.mitchell@iohk.io
Category	Distribution, Nix
Source repo	head: git clone https://github.com/input-output-hk/stack2nix.git
Uploaded	by jmitchell_iohk at 2017-06-22T23:05:27Z

Modules

[Index]

Stack2nix

Downloads

stack2nix-0.1.1.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

domenkozar, iohk_devops

For package maintainers and hackage trustees

edit package information

Readme for stack2nix-0.1.1.0

[back to package description]

stack2nix

About

stack2nix automates conversion from Stack configuration file to Nix expressions.

stack2nix high-level workflow:

invoke stack list-dependencies to determine complete fixed version list of packages based on resolver
apply any additional configuration (local packages, extra dependencies, etc) from stack.yaml
generate complete list of dependencies to Nix expressions, replacing upstream hackage-packages.nix

Installation

There are two options. The first is to install stack2nix and its dependencies on your machine directly, and the second is to use the supported virtual machine configuration.

If there are difficulties please file an issue. Generally the virtual machine approach should be more reliable.

Native Environment

Install nix.
Clone this repo.
Run stack install to install.
Ensure cabal2nix v2.2.1 or higher and stack2nix are in your $PATH.

Virtual Machine

Install VirtualBox and Vagrant.
Clone this repo.
Run ./scripts/vagrant.sh and take a coffee break.
If there are no errors, log into the VM: vagrant ssh.

Usage

Nix expressions generated by stack2nix depend on a somewhat recent upstream change to nixpkgs. If nix-env or nix-build fails with an error mentioning initialPackages, try setting the NIX_PATH environment variable: NIX_PATH=nixpkgs=https://github.com/NixOS/nixpkgs/archive/21a8239452adae3a4717772f4e490575586b2755.tar.gz.

Remote Packages

Stack2nix can generate a nix expressions for Haskell packages hosted in git repositories.

    $ stack2nix --revision 242e2a064f6a32b22e1599bbfe72e64d7b6203b8 https://github.com/jgm/pandoc.git > demo.nix
    $ nix-build -A pandoc demo.nix

Local Packages

Sometimes it's convenient to build local Haskell packages. Assuming the current directory is a locally maintained fork of Pandoc:

    $ stack2nix . > default.nix
    $ nix-build -A pandoc

Testing

Run ./scripts/travis.sh to build and test.