Skip to content

Commit 410c325

Browse files
committed
cabal, CHANGELOG: 0.10.1 release, unifying the changelog
* "Misc" use was disputed, moving back to use of the "Additional" category. * Using a (link) pattern for URLs, reasons being: * Including the markup into the outlines or hyperlinks considered a bad practice and should be used carefully. * The human cause: The reason for the changelog is so people read through it and get the info. Hyperlinks make text colored. Studies of readability have shown that people perceive the information of a brightly colored text much more poorly than the text of regular coloring. And delivering the meaning is what changelog text is for, so the informative text should be regularly colored. * The technical cause - the Hackage does not parse the markup inside the hyperlinks: https://hackage.haskell.org/package/hnix-0.10.0/changelog Probably because of the reason *1, but Hackage reason alone is enough. * Since people perceive and think about the read information mostly linearly and in the FIFO manner, `(link)` is put before information text, so links are placed in the same space and look more uniform upon reading. And upon reading the "link" context gets pushed first from the FIFO mind buffer and the further understanding the text the person is not distracted by sudden reading (taking-in) of the colored word "link" in the end of the semantically challenging text that is required to be understood. * Dependency requirements of last major versions made literal. * Link to `(diff)` made more obvious. While professionals tend to look for the link to the full diff, diff under version number is ambiguous to where the version number link leads, it can be for example: a GitHub release (where different forms of packages are provided), diff, commit listing (as it was before the current change), official forum post, official news... etc. * Made `(diff)` link to point directly towards the diff.
1 parent 1beaf46 commit 410c325

File tree

2 files changed

+48
-30
lines changed

2 files changed

+48
-30
lines changed

CHANGELOG.md

Lines changed: 47 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,62 @@
1+
12
# Changelog
23

3-
## [0.10.0](https://github.com/haskell-nix/hnix/compare/0.9.1...0.10.0) (2020-09-12)
4+
### [(diff)](https://github.com/haskell-nix/hnix/compare/0.10.0...0.10.1#files_bucket) 0.10.1 (2020-09-13)
5+
6+
* Additional:
7+
* [(link)](https://github.com/haskell-nix/hnix/pull/715/files) `{Binding, NExpr, NExprF, NKeyName}` gained `Ord1` instances.
8+
* These instances were required by downstream projects to be able to use newer HNix.
9+
* [(link)](https://github.com/haskell-nix/hnix/pull/712) CLI gained `--long-version` option for gathering a detailed debug information.
10+
* Currently, reports Git commit and its date.
11+
* [(link)](https://github.com/haskell-nix/hnix/issues/718) Currently does not work in case of use of the `nix-build`, in which case simply returns `UNKNOWN` placeholder.
12+
13+
14+
## [(diff)](https://github.com/haskell-nix/hnix/compare/0.9.1...0.10.0#files_bucket) 0.10.0 (2020-09-12)
415

516
* Breaking:
6-
* [Remove `ToJSON` and `FromJSON` instances for `NExpr`](https://github.com/haskell-nix/hnix/pull/699)
7-
* This also removes the JSON output feature for unevaluated expression trees.
8-
9-
* Misc:
10-
* [Update `data-fix` dependency to `>= 0.3.0 && < 0.4`](https://github.com/haskell-nix/hnix/pull/686)
11-
* [Update `prettyprinter` dependency to `= 1.7.0 && < 1.8`](https://github.com/haskell-nix/hnix/pull/679)
12-
* [CLI recieved `--version` option](https://github.com/haskell-nix/hnix/pull/703)
13-
14-
## [0.9.1](https://github.com/haskell-nix/hnix/compare/0.9.0...0.9.1) (2020-07-13)
15-
16-
* Misc:
17-
* REPL improvements
18-
* Better tab completion
19-
* Multi-line input
20-
* Support for passing evaluated expression result of `hnix --eval -E`
21-
to REPL as `input` variable.
22-
* Support for loading `.hnixrc` from current directory
23-
* Reporting of `builtins.nixVersion` bumped from 2.0 to 2.3
17+
* [(link)](https://github.com/haskell-nix/hnix/pull/699) Removed `NExpr` `{FromJSON, ToJSON}` instances.
18+
* This also removed the JSON output feature for unevaluated expression trees.
19+
20+
* Additional:
21+
* [(link)](https://github.com/haskell-nix/hnix/pull/703) CLI gained `--version` option.
22+
* Dependencies:
23+
* [(link)](https://github.com/haskell-nix/hnix/pull/686) Requires last major `data-fix` (`0.3`).
24+
* [(link)](https://github.com/haskell-nix/hnix/pull/679) Requires last major `prettyprinter` (`1.7`).
25+
26+
27+
### [(diff)](https://github.com/haskell-nix/hnix/compare/0.9.0...0.9.1#files_bucket) 0.9.1 (2020-07-13)
28+
29+
* Additional:
30+
* REPL:
31+
* Better tab completion.
32+
* Accepting multi-line input.
33+
* Support for passing evaluated expression result of `hnix --eval -E`.
34+
to REPL as an `input` variable.
35+
* Support for loading `.hnixrc` from the current directory.
36+
* Reporting of `builtins.nixVersion` bumped from 2.0 to 2.3.
2437
* Dependencies:
25-
* Freed from: `interpolate`, `contravariant`, `semigroups`, `generic-random`, `tasty-quickcheck`
26-
* `repline >= 0.4.0.0 && < 0.5`
38+
* Freed from: `{interpolate, contravariant, semigroups, generic-random, tasty-quickcheck}`.
39+
* Requires last major `repline` (`0.4`).
2740

28-
## [0.9.0](https://github.com/haskell-nix/hnix/compare/0.8.0...0.9.0) (2020-06-15)
2941

30-
* Changelog started. Previous release was `0.8.0`. In new release:
42+
## [(diff)](https://github.com/haskell-nix/hnix/compare/0.8.0...0.9.0#files_bucket) 0.9.0 (2020-06-15)
3143

3244
* Breaking:
33-
* Removed instances due to migration to `haskeline >= 0.8 && < 0.9`:
34-
* `instance MonadException m => MonadException(StateT(HashMap FilePath NExprLoc) m)`
35-
* `instance MonadException m => MonadException(Fix1T StandardTF m)`
45+
* Removed instances due to migration to `haskeline 0.8`:
46+
* `instance MonadException m => MonadException(StateT(HashMap FilePath NExprLoc) m)`.
47+
* `instance MonadException m => MonadException(Fix1T StandardTF m)`.
48+
* Dependencies:
49+
* Requires last major `haskeline` (`0.8`).
50+
51+
* Additional:
52+
* Library: Official support for `GHC 8.4 - 8.10`.
53+
* Executable complies only under `GHC 8.10`.
54+
55+
* Changelog started. Previous release was `0.8.0`.
3656

37-
* Misc:
38-
* Library: Official support for `GHC 8.4 - 8.10`
3957

4058
---
4159

42-
`HNix` uses [PVP Versioning][1].
60+
HNix uses [PVP Versioning][1].
4361

4462
[1]: https://pvp.haskell.org

hnix.cabal

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: hnix
2-
version: 0.10.0
2+
version: 0.10.1
33
synopsis: Haskell implementation of the Nix language
44
description: Haskell implementation of the Nix language.
55
category: System, Data, Nix

0 commit comments

Comments
 (0)