slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: changelogs: cleanup, finalise

Browse Source
This commit is contained in:
Simon Michael 2021-09-21 16:28:07 -10:00
parent 416555b65a
commit e90fa3ee81
5 changed files with 67 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
CHANGES.md
View File

@ -9,15 +9,32 @@
General changes in the hledger project (and notable all-package releases). General changes in the hledger project (and notable all-package releases).
For package-specific changes and minor releases, see the hledger package changelogs. For package-specific changes and minor releases, see the hledger package changelogs.
# c2e6a2931 # 1.23 2021-09-21
- Added a public BACKLOG.org to the hledger repo and website. Software:
- The bin/hledger-check-fancyassertions.hs addon script, - The bin/hledger-check-fancyassertions.hs addon script,
allowing more complex balance assertions, works again. allowing more complex balance assertions, works again.
(#1464, Stephen Morgan) (#1464, Stephen Morgan)
- many code cleanups suggested by hlint (Stephen Morgan) - Many code cleanups suggested by hlint (Stephen Morgan)
Docs:
- Added a public BACKLOG.org to the hledger repo and website.
- Website updates:
- Reorganised site content.
- Improved page tables of contents.
- Content fixes.
- New docs:
Currency conversion.
hledger and Beancount/GnuCash/Ledger/Quicken.
- New examples: systemd and nginx configs for hledger-web (Alan Young)
Tools/process:
- `make site-watch` works again - `make site-watch` works again
@ -26,21 +43,11 @@ For package-specific changes and minor releases, see the hledger package changel
- `Shake cabalfiles` now uses (and requires) hpack in $PATH, to avoid building. - `Shake cabalfiles` now uses (and requires) hpack in $PATH, to avoid building.
It should be the version that's in the current stack release, to avoid commit conflicts. It should be the version that's in the current stack release, to avoid commit conflicts.
- website updates:
- Reorganised site content.
- Improved page tables of contents.
- Content fixes.
- New docs:
Currency conversion.
hledger and Beancount/GnuCash/Ledger/Quicken.
- shake: changelogs: A leading semicolon now means - shake: changelogs: A leading semicolon now means
"skip most CI steps", not "omit from changelog". "skip most CI steps", not "omit from changelog".
- ci: most steps are skipped if commit message begins with ;. - ci: most steps are skipped if commit message begins with ;.
- New examples: systemd and nginx configs for hledger-web (Alan Young)
- hledger developers now use GHC 9.0/stackage nightly by default. (#1503) - hledger developers now use GHC 9.0/stackage nightly by default. (#1503)
- Our doctests are disabled with GHC 9 for now to work around an - Our doctests are disabled with GHC 9 for now to work around an

4
hledger-lib/CHANGES.md
View File

@ -9,7 +9,7 @@
Internal/api/developer-ish changes in the hledger-lib (and hledger) packages. Internal/api/developer-ish changes in the hledger-lib (and hledger) packages.
For user-visible changes, see the hledger package changelog. For user-visible changes, see the hledger package changelog.
# 378df7700 # 1.23 2021-09-21
- Require base >=4.11, prevent red squares on Hackage's build matrix. - Require base >=4.11, prevent red squares on Hackage's build matrix.
@ -67,7 +67,7 @@ Much code cleanup and reorganisation, such as:
as it is now equivalent to utcTimeToPOSIXSeconds from Data.Time.Clock.POSIX. as it is now equivalent to utcTimeToPOSIXSeconds from Data.Time.Clock.POSIX.
To get the current system time, you should now use getPOSIXTime To get the current system time, you should now use getPOSIXTime
from Data.Time.Clock.POSIX instead of getClockTime. from Data.Time.Clock.POSIX instead of getClockTime.
(#1650, Stephen Morgan) ([#1650](https://github.com/simonmichael/hledger/issues/1650), Stephen Morgan)
- modifyTransactions now takes a Map of commodity styles, and will style amounts according to that argument. journalAddForecast and journalTransform now return an Either String Journal. (Stephen Morgan) - modifyTransactions now takes a Map of commodity styles, and will style amounts according to that argument. journalAddForecast and journalTransform now return an Either String Journal. (Stephen Morgan)
This improves efficiency, as we no longer have to restyle all amounts in This improves efficiency, as we no longer have to restyle all amounts in

6
hledger-ui/CHANGES.md
View File

@ -9,7 +9,7 @@
User-visible changes in hledger-ui. User-visible changes in hledger-ui.
See also the hledger changelog. See also the hledger changelog.
# 9cae7a076 # 1.23 2021-09-21
Improvements Improvements
@ -17,6 +17,8 @@ Improvements
API changes API changes
- Lenses are now available for UIState etc., saving a lot of boilerplate. (Stephen Morgan)
- Renamed: - Renamed:
``` ```
version -> packageversion version -> packageversion
@ -24,8 +26,6 @@ API changes
UIOpts fields UIOpts fields
``` ```
- Lenses are now available for UIState etc., saving a lot of boilerplate. (Stephen Morgan)
# 1.22.2 2021-08-07 # 1.22.2 2021-08-07
- Use hledger 1.22.2. - Use hledger 1.22.2.

13
hledger-web/CHANGES.md
View File

@ -9,7 +9,7 @@ __ _____| |__
User-visible changes in hledger-web. User-visible changes in hledger-web.
See also the hledger changelog. See also the hledger changelog.
# 9cae7a076 # 1.23 2021-09-21
Improvements Improvements
@ -19,18 +19,21 @@ Improvements
Fixes Fixes
- Toggle showing zero items properly even when called with --empty. (#1237) (Stephen Morgan) - Toggle showing zero items properly even when called with --empty.
([#1237](https://github.com/simonmichael/hledger/issues/1237), Stephen Morgan)
- Do not hide empty accounts if they have non-empty subaccounts. (#1237) (Stephen Morgan) - Do not hide empty accounts if they have non-empty subaccounts.
([#1237](https://github.com/simonmichael/hledger/issues/1237), Stephen Morgan)
- Allow unbalanced postings (parenthesised account name) in the add transaction form. (#1058) (Stephen Morgan) - Allow unbalanced postings (parenthesised account name) in the add transaction form.
([#1058](https://github.com/simonmichael/hledger/issues/1058), Stephen Morgan)
- An XSS (cross-site scripting) vulnerability has been fixed. - An XSS (cross-site scripting) vulnerability has been fixed.
Previously (since hledger-web 0.24), javascript code could be added Previously (since hledger-web 0.24), javascript code could be added
to any autocompleteable field and could be executed automatically to any autocompleteable field and could be executed automatically
by subsequent visitors viewing the journal. by subsequent visitors viewing the journal.
Thanks to Gaspard Baye and Hamidullah Muslih for reporting this vulnerability. Thanks to Gaspard Baye and Hamidullah Muslih for reporting this vulnerability.
(#1525, Arsen Arsenović) ([#1525](https://github.com/simonmichael/hledger/issues/1525), Arsen Arsenović)
API changes API changes

69
hledger/CHANGES.md
View File

@ -9,7 +9,7 @@
User-visible changes in the hledger command line tool and library. User-visible changes in the hledger command line tool and library.
# 9cae7a076 # 1.23 2021-09-21
Features Features
@ -19,17 +19,22 @@ Features
precisely, between the value of the amounts' costs and the value of precisely, between the value of the amounts' costs and the value of
the amounts on the valuation date(s). (Ie, you can report gain in a the amounts on the valuation date(s). (Ie, you can report gain in a
different currency.) different currency.)
(#1623, #1432, Stephen Morgan, Charlotte Van Petegem) ([#1623](https://github.com/simonmichael/hledger/issues/1623),
[#1432](https://github.com/simonmichael/hledger/issues/1432),
Stephen Morgan, Charlotte Van Petegem)
- The new `-c/--commodity-style` option makes it easy to override - The new `-c/--commodity-style` option makes it easy to override
commodity display styles at runtime, eg to adjust the number of commodity display styles at runtime, eg to adjust the number of
decimal places or change the position of the symbol. decimal places or change the position of the symbol.
(#1593, Arjen Langebaerd) ([#1593](https://github.com/simonmichael/hledger/issues/1593), Arjen Langebaerd)
- The balance commands have a new `--commodity-column` flag that - The balance commands have a new `--commodity-column` flag that
displays commodity symbols in a dedicated column, showing one line displays commodity symbols in a dedicated column, showing one line
per commodity and all amounts as bare numbers. per commodity and all amounts as bare numbers.
(#1559, #1626, #1654, Lawrence Wu, Simon Michael, Stephen Morgan) ([#1559](https://github.com/simonmichael/hledger/issues/1559),
[#1626](https://github.com/simonmichael/hledger/issues/1626),
[#1654](https://github.com/simonmichael/hledger/issues/1654),
Lawrence Wu, Simon Michael, Stephen Morgan)
- The `balance --budget` option can now take an argument, - The `balance --budget` option can now take an argument,
a case insensitive description substring which selects a subset of a case insensitive description substring which selects a subset of
@ -42,26 +47,35 @@ Features
`every mon,wed,...` (multiple days of the week). `every mon,wed,...` (multiple days of the week).
This is intended for periodic transaction rules used with This is intended for periodic transaction rules used with
`--forecast` (or `bal --budget`). `--forecast` (or `bal --budget`).
(#1632, Lawrence Wu) ([#1632](https://github.com/simonmichael/hledger/issues/1632), Lawrence Wu)
- The new `--today=DATE` option allows overriding today's date. This - The new `--today=DATE` option allows overriding today's date. This
can be useful in tests and examples using relative dates, to make can be useful in tests and examples using relative dates, to make
them reproducible. them reproducible.
(#1674) (Stephen Morgan) ([#1674](https://github.com/simonmichael/hledger/issues/1674), Stephen Morgan)
Improvements
- In CSV rules, multi-line comments are now supported. Newlines in CSV - In CSV rules, multi-line comments are now supported. Newlines in CSV
data are preserved, or newlines can be added by writing `\n` when data are preserved, or newlines can be added by writing `\n` when
assigning to `comment`, `comment1` etc. (Malte Brandy) assigning to `comment`, `comment1` etc.
(Malte Brandy)
Improvements
- Incremental performance improvements; hledger 1.23 is the fastest
hledger yet, about 10% faster than 1.22.
(Stephen Morgan)
- `register` no longer slows down when there are many report intervals.
([#1683](https://github.com/simonmichael/hledger/issues/1683), Stephen Morgan)
- Numbers in SQL output now always use decimal period (`.`), - Numbers in SQL output now always use decimal period (`.`),
independent of commodity display styles. (Stephen Morgan) independent of commodity display styles.
(Stephen Morgan)
- `--sort` now gives a more intuitive sort oder when there are - `--sort` now gives a more intuitive sort oder when there are
multiple commodities. Negative numbers in one commodity are always multiple commodities. Negative numbers in one commodity are always
less than positive numbers in another commodity. less than positive numbers in another commodity.
(#1563, Stephen Morgan) ([#1563](https://github.com/simonmichael/hledger/issues/1563), Stephen Morgan)
- `--infer-market-price` has been renamed to `--infer-market-prices`. - `--infer-market-price` has been renamed to `--infer-market-prices`.
(The old spelling still works, since we accept flag prefixes.) (The old spelling still works, since we accept flag prefixes.)
@ -69,35 +83,15 @@ Improvements
- Our pretty-printed JSON now orders object attributes alphabetically, - Our pretty-printed JSON now orders object attributes alphabetically,
across all GHC and haskell lib versions. across all GHC and haskell lib versions.
- `register` no longer slows down when there are many report intervals.
(#1683) (Stephen Morgan)
- Various other incremental performance improvements have been made. (Stephen Morgan)
- register with a report interval starting on custom dates - register with a report interval starting on custom dates
(eg: `hledger reg -p "every 15th day of month") now makes the (eg: `hledger reg -p "every 15th day of month") now makes the
date column wide enough to show the start and end dates. date column wide enough to show the start and end dates.
It also wastes less whitespace after the column. It also wastes less whitespace after the column.
(#1655, Stephen Morgan) ([#1655](https://github.com/simonmichael/hledger/issues/1655), Stephen Morgan)
- The --forecast option will now reject a report interval in its - The --forecast option will now reject a report interval in its
argument, instead of silently ignoring it. argument, instead of silently ignoring it.
- doc: clarify period expressions, report intervals
- Clarify version string code:
```
version -> packageversion
versiondescription -> versionStringFor
```
- Require githash >=0.1.4.0, simplify version code.
- Require base >=4.11, prevent red squares on Hackage's build matrix.
(We officially support GHC 8.6+, which means base 4.12,
but Hackage shows all packages building successfully with
base 4.11/GHC 8.4+ somehow, so it's still allowed..)
- In JSON output, object attributes are now ordered alphabetically, - In JSON output, object attributes are now ordered alphabetically,
consistently for all GHC and haskell lib versions. consistently for all GHC and haskell lib versions.
([#1618](https://github.com/simonmichael/hledger/issues/1618), Stephen Morgan) ([#1618](https://github.com/simonmichael/hledger/issues/1618), Stephen Morgan)
@ -142,20 +136,25 @@ Improvements
[#1667](https://github.com/simonmichael/hledger/issues/1667), [#1667](https://github.com/simonmichael/hledger/issues/1667),
Stephen Morgan, Simon Michael) Stephen Morgan, Simon Michael)
- Require base >=4.11, prevent red squares on Hackage's build matrix.
(We officially support GHC 8.6+, which means base 4.12,
but Hackage shows all packages building successfully with
base 4.11/GHC 8.4+ somehow, so it's still allowed..)
Fixes Fixes
- A rare bug causing incorrect balances to be reported by the - A rare bug causing incorrect balances to be reported by the
cf/bs/bse/is commands, since hledger 1.19, has been fixed. cf/bs/bse/is commands, since hledger 1.19, has been fixed.
(cf/bs/bse/is with --tree --no-elide --begin DATE and certain (cf/bs/bse/is with --tree --no-elide --begin DATE and certain
account directives could show wrong balances). account directives could show wrong balances).
(#1698) (Stephen Morgan) ([#1698](https://github.com/simonmichael/hledger/issues/1698), Stephen Morgan)
- aregister now aligns multicommodity amounts properly (broken since 1.21). - aregister now aligns multicommodity amounts properly (broken since 1.21).
(#1656, Stephen Morgan) ([#1656](https://github.com/simonmichael/hledger/issues/1656), Stephen Morgan)
- `balance -E` (and hledger-ui Z) now correctly show zero parent accounts, - `balance -E` (and hledger-ui Z) now correctly show zero parent accounts,
fixing a bug introduced in hledger 1.19. fixing a bug introduced in hledger 1.19.
(#1688) (Stephen Morgan) ([#1688](https://github.com/simonmichael/hledger/issues/1688), Stephen Morgan)
- The `roi` command no longer gives an ugly error in a certain case - The `roi` command no longer gives an ugly error in a certain case
with PnL applied on the first day of investment. (Dmitry Astapov) with PnL applied on the first day of investment. (Dmitry Astapov)