git.iko.soy/haskell.nix
on hkm/aarch64-linux-remote-fix help sign in
haskell.nix/changelog.md
198 lines 8.7 kB history raw
1This file contains a summary of changes to Haskell.nix and `nix-tools`
2that will impact users.
4## Aug 6, 2021
5* Included dependencies of haskell.nix that were tracked in `nix/sources.json`
6 as flake inputs (`flake.lock` replaces `nix/sources.json`).
7* Uses `flake-compat` to continue to provide a compatible interface for non
8 flake projects.
10## Jul 23, 2021
11* `source-repository-package` references in `cabal.project` files are now
12 left as a `source-repository-package` when calculating the the `plan-nix` for
13 `cabalProject` based functions.
14 This makes haskell.nix match the behaviour of `cabal` better.
15 Materialized files for projects that use `source-repository-package`
16 references will need to be updated.
17* Only planned components are included in a haskell.nix cabal project.
18 If cabal solver does not include the component in the `plan.json` file it
19 will not be present in `hsPkgs.pkg.components`.
20* When the same package occurs more than once in a plan.json file
21 the latest version is picked by haskell.nix.
23## Apr 8, 2021
24* Project arguments are now validated with the Nix module system.
25 If unexpected argments are passed to a project function this may now
26 result in an error.
28## Feb 22, 2021
29* Add `.dwarf` to build any component with DWARF dubug info on linux
30 (ghc >=8.10.2).
31* Pass `enableDWARF` to `shellFor` for to get a shell where all the
32 components are the `.dwarf` ones.
34## Feb 18, 2021
35* `ghcOptions` has been moved from package and is now a list of strings.
36 old: packages.x.package.ghcOptions = "someGHCoption";
37 new: packages.x.ghcOptions = ["someGHCoption"];
38 To specify ghcOptions for all packages:
39 ghcOptions = ["someGHCoption"];
40 For a single component:
41 packages.x.compoents.library.ghcOptions = ["someGHCoption"];
43## Feb 8, 2021
44* Removed older versions of haskell-language-server from custom-tools
45 (0.8.0 is in hackage so we can still get that version).
47## Jan 14, 2021
48* Added support for cross package refs (with a project). Relative
49 directory references between packages within a project should now
50 work.
51* Added `includeSiblings` to `cleanSourceWith`. When `true` it
52 prevents the `subDir` arg from causing filtering of other directories.
53* Added `keepGitDir` to `cleanGit` to allow `.git` directory to be kept
54 (useful for components that use the `githash` package).
56## Nov 26, 2020
57* Renamed `otherShells` arg for `shellFor` to `inputsFrom
59## Nov 25, 2020
60* The `shellFor` `makeConfigFiles` `ghcWithHoogle` and `ghcWithPackages`
61 functions have been removed from `project.hsPkgs`. Instead access
62 them from `project` itself (e.g. change `p.hsPkgs.shellFor` to `p.shellFor`).
63* The reflex-platform like `project.shells.ghc` has been removed.
64 If needed, add something like `p // { shells.ghc = p.shellFor {} }`
65 to `shell.nix`.
67## Nov 24, 2020
68* Added `${targetPrefix}cabal` wrapper script for running cross
69 compilers in `shellFor`.
70* `otherShells` arg added to `shellFor`.
72## Oct 31, 2020
73* Passing `tools.hoogle` to `shellFor` with a value suitable for `haskel-nix.tool` will
74 use the specified `hoogle` inside `shellFor`. This allows for materialization
75 of `hoogle`.
77## Oct 28, 2020
78* Passing `compiler-nix-name` to project functions for `stack.yaml`
79 based projects now overrides the compiler used (was ignored before).
81## Sep 8, 2020
82* Added the ability to generate coverage reports for packages and
83 projects.
84* Added the `doCoverage` module option that allows users to choose
85 packages to enable coverage for.
86* Added a `doCoverage` flag to the component builder that outputs HPC
87 information when coverage is enabled.
88* Added test for coverage.
90## July 21, 2020
91* Removed `components.all`, use `symlinkJoin` on components.exes or
92 `shellFor` if you need a shell.
93* Added `components` argument to `shellFor`.
95## July 21, 2020
96* Added GHC 8.8.4 and replaced 8.8.3 in tests and as the ghc
97 used to build nix-tools for stack projects.
99## July 20, 2020
100* Changed `haskell-nix.roots` and `p.roots` to single derivations.
102## July 8, 2020
103* Removed `sources.nixpkgs-default`, use `sources.nixpkgs` instead.
104* Removed `./nixpkgs` directory, use `(import ./. {}).sources`
105 or `./nix/sources.nix` instead.
106* Removes V1 interface for details on how to fix old code see:
107 https://github.com/input-output-hk/haskell.nix/issues/709
108* Removed defaultCompilerNixName.
109* cabalProject, cabalProject', hackage-project and hackage-package
110 now require a `compiler-nix-name` argument.
111* `haskell-nix.tool` and `.tools` now require a `compiler-nix-name` argument.
112 New functions `p.tool` and `p.tools` (where p is a project) do not.
113 Like `shellFor { tools = ... }` they will use the compiler nix name
114 from the project (including stack projects where it is derived from
115 the resolver).
116* `haskell-nix.alex` and `haskell-nix.happy` have been removed. Use
117 `p.tool "alex" "3.2.5"` or `shellFor { tools = { alex = "3.2.5"; } }`.
118* `haskell-nix.nix-tools` -> `haskell-nix.nix-tools.ghc883` (it includes
119 the hpack exe now).
120* `haskell-nix.cabal-install` ->
121 `p.tool "cabal" "3.2.0.0"` or `shellFor { tools = { cabal = "3.2.0.0"; } }`
122* `haskell-nix.haskellNixRoots` -> `haskell-nix.roots ghc883` or `p.roots`
124## June 25, 2020
125* Haddock docs are now built in their own derivation when needed (not as part
126 of the component build).
127 They should build automatically when something (such as `shellFor`) attempts
128 to accesses the `.doc` attribute of component.
130## December 27, 2019
131* Fix overlays/bootstrap.nix to provide LLVM 6, not LLVM 5, to ghc-8.6.X compilers.
133## November 18, 2019
134 * Changed the `cleanSourceHaskell` to accept an attrset of `src` and
135 (optional) `name` parameters. This allows you to keep the source
136 derivation name constant, so that your builds are always
137 cached. Usage of `cleanSourceHaskell` will need to be updated.
139## October 12, 2019
140 * [`shellFor`](https://input-output-hk.github.io/haskell.nix/reference/library/#shellfor) no longer sets `CABAL_CONFIG` by default.
141 This avoids surprising users, but means that Cabal may select a plan which is different to your Haskell.nix package set.
142 If you would like the old behaviour, use `shellFor { exactDeps = true; }`.
144## August 9, 2019
145 * Add the [`haskellLib.collectComponents`](https://input-output-hk.github.io/haskell.nix/reference/library/#haskellLib) function.
147## June 21, 2019
148 * Add `ghcWithPackages` and `ghcWithHoogle` to hsPkgs ([documentation](https://input-output-hk.github.io/haskell.nix/reference/library/#package-set-functions).
149 * Benchmark components can now build successfully.
150 * Reduced the closure bloat of nix-tools, and added closure size limit to CI.
151 * Added more reference documentation and set up auto-generated
152 documentation for [Module Options](https://input-output-hk.github.io/haskell.nix/reference/modules/).
153 * Miscellaneous bug fixes.
155## June 7, 2019
156 * Several additions to the [documentation](https://input-output-hk.github.io/haskell.nix/).
157 * More information about getting nix-tools, Haskell.nix, pinning.
158 * Updates the stack-to-nix and cabal-to-nix guides.
159 * Adds a section on development environments.
160 * Adds a little information about cross compilation.
161 * Adds a (partially complete) reference section (command line manuals, library reference).
162 * Symlinks the changelog into the documentation pages.
164## May 29, 2019
165 * Added `shellFor` function to package set.
167## May 28, 2019
168 * Added `snaphots` and `haskellPackages` attributes to the
169 Haskell.nix top-level.
171## May 22, 2019
172 * Add the `cleanSourceHaskell` utility function to the Haskell.nix
173 top-level.
175## May 21, 2019
176 * Add the `callCabalProjectToNix` function, which uses "import from
177 derivation" (IFD) so that nix-tools doesn't need to be run
178 manually.
179 * The `hackage.nix` update process has changed, so that Cabal index
180 state hashes are also included in the generated repo.
182## May 20, 2019
183 * Remove Travis CI in favour of Buildkite.
185## May 17, 2019
186 * Add the `callStackToNix` function, which uses "import from
187 derivation" (IFD) so that `stack-to-nix` doesn't need to be run
188 manually.
190## Mar 15, 2019
191 * `overlays` was renamed to `extras` in
192 [#79](https://github.com/input-output-hk/haskell.nix/pull/79)
193 to prevent confusion between the notion of Nix overlays.
195 Therefore `plan-pkgs` and `stack-pkgs` as generated by `plan-to-nix` and `stack-to-nix` will
196 expose `extras` instead of `overlay`. Similarly `mkStackPkgSet`, `mkPkgSet` and `mkCabalProjectPkgSet`
197 take a `pkg-def-extras` instead of `pkg-def-overlay` argument. If you are using `iohk-nix`, the
198 `iohk-overlay` was parameter was renamed to `iohk-extras`.