git.iko.soy/haskell.nix
on hkm/pin-boot-pkgs help sign in
haskell.nix/changelog.md
155 lines 6.9 kB history raw
1This file contains a summary of changes to Haskell.nix and `nix-tools`
2that will impact users.
4## Jan 14, 2021
5* Added support for cross package refs (with a project). Relative
6 directory references between packages within a project should now
7 work.
8* Added `includeSiblings` to `cleanSourceWith`. When `true` it
9 prevents the `subDir` arg from causing filtering of other directories.
10* Added `keepGitDir` to `cleanGit` to allow `.git` directory to be kept
11 (useful for components that use the `githash` package).
13## Nov 26, 2020
14* Renamed `otherShells` arg for `shellFor` to `inputsFrom
16## Nov 25, 2020
17* The `shellFor` `makeConfigFiles` `ghcWithHoogle` and `ghcWithPackages`
18 functions have been removed from `project.hsPkgs`. Instead access
19 them from `project` itself (e.g. change `p.hsPkgs.shellFor` to `p.shellFor`).
20* The reflex-platform like `project.shells.ghc` has been removed.
21 If needed, add something like `p // { shells.ghc = p.shellFor {} }`
22 to `shell.nix`.
24## Nov 24, 2020
25* Added `${targetPrefix}cabal` wrapper script for running cross
26 compilers in `shellFor`.
27* `otherShells` arg added to `shellFor`.
29## Oct 31, 2020
30* Passing `tools.hoogle` to `shellFor` with a value suitable for `haskel-nix.tool` will
31 use the specified `hoogle` inside `shellFor`. This allows for materialization
32 of `hoogle`.
34## Oct 28, 2020
35* Passing `compiler-nix-name` to project functions for `stack.yaml`
36 based projects now overrides the compiler used (was ignored before).
38## Sep 8, 2020
39* Added the ability to generate coverage reports for packages and
40 projects.
41* Added the `doCoverage` module option that allows users to choose
42 packages to enable coverage for.
43* Added a `doCoverage` flag to the component builder that outputs HPC
44 information when coverage is enabled.
45* Added test for coverage.
47## July 21, 2020
48* Removed `components.all`, use `symlinkJoin` on components.exes or
49 `shellFor` if you need a shell.
50* Added `components` argument to `shellFor`.
52## July 21, 2020
53* Added GHC 8.8.4 and replaced 8.8.3 in tests and as the ghc
54 used to build nix-tools for stack projects.
56## July 20, 2020
57* Changed `haskell-nix.roots` and `p.roots` to single derivations.
59## July 8, 2020
60* Removed `sources.nixpkgs-default`, use `sources.nixpkgs` instead.
61* Removed `./nixpkgs` directory, use `(import ./. {}).sources`
62 or `./nix/sources.nix` instead.
63* Removes V1 interface for details on how to fix old code see:
64 https://github.com/input-output-hk/haskell.nix/issues/709
65* Removed defaultCompilerNixName.
66* cabalProject, cabalProject', hackage-project and hackage-package
67 now require a `compiler-nix-name` argument.
68* `haskell-nix.tool` and `.tools` now require a `compiler-nix-name` argument.
69 New functions `p.tool` and `p.tools` (where p is a project) do not.
70 Like `shellFor { tools = ... }` they will use the compiler nix name
71 from the project (including stack projects where it is derived from
72 the resolver).
73* `haskell-nix.alex` and `haskell-nix.happy` have been removed. Use
74 `p.tool "alex" "3.2.5"` or `shellFor { tools = { alex = "3.2.5"; } }`.
75* `haskell-nix.nix-tools` -> `haskell-nix.nix-tools.ghc883` (it includes
76 the hpack exe now).
77* `haskell-nix.cabal-install` ->
78 `p.tool "cabal" "3.2.0.0"` or `shellFor { tools = { cabal = "3.2.0.0"; } }`
79* `haskell-nix.haskellNixRoots` -> `haskell-nix.roots ghc883` or `p.roots`
81## June 25, 2020
82* Haddock docs are now built in their own derivation when needed (not as part
83 of the component build).
84 They should build automatically when something (such as `shellFor`) attempts
85 to accesses the `.doc` attribute of component.
87## December 27, 2019
88* Fix overlays/bootstrap.nix to provide LLVM 6, not LLVM 5, to ghc-8.6.X compilers.
90## November 18, 2019
91 * Changed the `cleanSourceHaskell` to accept an attrset of `src` and
92 (optional) `name` parameters. This allows you to keep the source
93 derivation name constant, so that your builds are always
94 cached. Usage of `cleanSourceHaskell` will need to be updated.
96## October 12, 2019
97 * [`shellFor`](https://input-output-hk.github.io/haskell.nix/reference/library/#shellfor) no longer sets `CABAL_CONFIG` by default.
98 This avoids surprising users, but means that Cabal may select a plan which is different to your Haskell.nix package set.
99 If you would like the old behaviour, use `shellFor { exactDeps = true; }`.
101## August 9, 2019
102 * Add the [`haskellLib.collectComponents`](https://input-output-hk.github.io/haskell.nix/reference/library/#haskellLib) function.
104## June 21, 2019
105 * Add `ghcWithPackages` and `ghcWithHoogle` to hsPkgs ([documentation](https://input-output-hk.github.io/haskell.nix/reference/library/#package-set-functions).
106 * Benchmark components can now build successfully.
107 * Reduced the closure bloat of nix-tools, and added closure size limit to CI.
108 * Added more reference documentation and set up auto-generated
109 documentation for [Module Options](https://input-output-hk.github.io/haskell.nix/reference/modules/).
110 * Miscellaneous bug fixes.
112## June 7, 2019
113 * Several additions to the [documentation](https://input-output-hk.github.io/haskell.nix/).
114 * More information about getting nix-tools, Haskell.nix, pinning.
115 * Updates the stack-to-nix and cabal-to-nix guides.
116 * Adds a section on development environments.
117 * Adds a little information about cross compilation.
118 * Adds a (partially complete) reference section (command line manuals, library reference).
119 * Symlinks the changelog into the documentation pages.
121## May 29, 2019
122 * Added `shellFor` function to package set.
124## May 28, 2019
125 * Added `snaphots` and `haskellPackages` attributes to the
126 Haskell.nix top-level.
128## May 22, 2019
129 * Add the `cleanSourceHaskell` utility function to the Haskell.nix
130 top-level.
132## May 21, 2019
133 * Add the `callCabalProjectToNix` function, which uses "import from
134 derivation" (IFD) so that nix-tools doesn't need to be run
135 manually.
136 * The `hackage.nix` update process has changed, so that Cabal index
137 state hashes are also included in the generated repo.
139## May 20, 2019
140 * Remove Travis CI in favour of Buildkite.
142## May 17, 2019
143 * Add the `callStackToNix` function, which uses "import from
144 derivation" (IFD) so that `stack-to-nix` doesn't need to be run
145 manually.
147## Mar 15, 2019
148 * `overlays` was renamed to `extras` in
149 [#79](https://github.com/input-output-hk/haskell.nix/pull/79)
150 to prevent confusion between the notion of Nix overlays.
152 Therefore `plan-pkgs` and `stack-pkgs` as generated by `plan-to-nix` and `stack-to-nix` will
153 expose `extras` instead of `overlay`. Similarly `mkStackPkgSet`, `mkPkgSet` and `mkCabalProjectPkgSet`
154 take a `pkg-def-extras` instead of `pkg-def-overlay` argument. If you are using `iohk-nix`, the
155 `iohk-overlay` was parameter was renamed to `iohk-extras`.