From 1085a2a7775017739c2429aeaf392f72cf151daf Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sun, 29 May 2022 08:04:31 -1000 Subject: [PATCH] ;doc: update changelogs --- CHANGES.md | 24 ++++++++++++++----- hledger-lib/CHANGES.md | 52 +++++++++++++++++++++++++++++------------- hledger-ui/CHANGES.md | 4 +++- hledger-web/CHANGES.md | 8 ++++++- hledger/CHANGES.md | 51 +++++++++++++++++++++++++++++------------ 5 files changed, 100 insertions(+), 39 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index ecaf430bc..66d11ae4e 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -9,13 +9,17 @@ General changes in the hledger project. For package-specific changes, see the hledger package changelogs. -# 7a1d5e66e +# 05d5b7860 Scripts/addons +- renamed hledger-number.sh to hledger-simplebal + +- added hledger-git, hledger-pijul + - fin (and bin) scripts show available scripts and their help -- aliases.sh -> bashrc +- renamed aliases.sh to bashrc - Get hledger-print-location working. (Stephen Morgan) @@ -32,12 +36,20 @@ Examples - invoice: calculate dates accurately on last days of month -Process/tools +Process -- ci: master now requires all pushes/merges, including Simon's, to - have passed the `push` CI tests on some other github branch first. +- Stackage nightly and GHC 9.2 are now the default for dev builds. -- make buildtimes, make buildtimes-cabal: show GHC codegen times +- CI workflows: + + - Workflows and binaries have more consistent naming, mentioning platform and architecture. + - The main test workflow is now `linux-x64-test`, replacing `push` and `pull`. + It runs for both pushes and pull requests, and generates binaries on every run. + - Pushes/merges to master, including Simon's, are required to have passed + `linux-x64-test` on another github branch first. + - Mac and Windows binaries are now stripped also (if applicable). + +- `make buildtimes`, `make buildtimes-cabal` show GHC codegen times. # 1.25 2022-03-04 diff --git a/hledger-lib/CHANGES.md b/hledger-lib/CHANGES.md index 29b15c6d8..3819d7dc9 100644 --- a/hledger-lib/CHANGES.md +++ b/hledger-lib/CHANGES.md @@ -9,14 +9,14 @@ Internal/api/developer-ish changes in the hledger-lib (and hledger) packages. For user-visible changes, see the hledger package changelog. -# 8de85be65 +# 2bce91090 Breaking changes - readJournal, readJournalFile, readJournalFiles now return `ExceptT String IO a` instead of `IO (Either String a)`. Internally, this increases composability and avoids some ugly case handling. -It means that these must now be evaluated with `runExceptT`. + It means that these must now be evaluated with `runExceptT`. That can be imported from `Control.Monad.Except` in the `mtl` package, but `Hledger.Read` also re-exports it for convenience. @@ -25,25 +25,45 @@ It means that these must now be evaluated with `runExceptT`. assuming default input options and needing one less argument. (Stephen Morgan) -Misc - -- Hledger.Query: Added - matchesQuery, - queryIsCode - queryIsTransactionRelated - -- Clean up journal parsing. (Stephen Morgan) - parseAndFinaliseJournal' has been removed. In the unlikely event you - needed it in your code, you can replace it with: - - parseAndFinaliseJournal' parser iopts fp t => +- parseAndFinaliseJournal' (a variant of parseAndFinaliseJournal) has been removed. + In the unlikely event you needed it in your code, you can replace: + ```haskell + parseAndFinaliseJournal' parser iopts fp t + ``` + with: + ```haskell initialiseAndParseJournal parser iopts fp t >>= liftEither . journalApplyAliases (aliasesFromOpts iopts) >>= journalFinalise iopts fp t + ``` - Some parsers have been generalised from JournalParser to TextParser. +- Some parsers have been generalised from JournalParser to TextParser. + (Stephen Morgan) -- Improve ergonomics of SmartDate constructors. (Stephen Morgan) +Misc. changes + +- Our doctests now run with GHC 9.2+ only, to avoid doctest issues. + +- Hledger.Data.JournalChecks: some Journal checks have been moved and renamed: + journalCheckAccounts, + journalCheckCommodities, + journalCheckPayees + +- Hledger.Data.Errors: new error formatting helpers + makeTransactionErrorExcerpt, + makePostingErrorExcerpt, + transactionFindPostingIndex + +- HledgerParseErrors is a new type alias for our parse errors. + CustomErr has been renamed to HledgerParseErrorData. + +- Hledger.Query: added + matchesQuery, + queryIsCode, + queryIsTransactionRelated + +- Improve ergonomics of SmartDate constructors. + (Stephen Morgan) - Hledger.Utils: Add a helper function numDigitsInt to get the number of digits in an integer, which has a surprising number of ways to diff --git a/hledger-ui/CHANGES.md b/hledger-ui/CHANGES.md index 66e2650e2..fffbfcb55 100644 --- a/hledger-ui/CHANGES.md +++ b/hledger-ui/CHANGES.md @@ -9,7 +9,9 @@ User-visible changes in hledger-ui. See also the hledger changelog. -# 8de85be65 +# 2bce91090 + +- Uses hledger 1.26. # 1.25 2022-03-04 diff --git a/hledger-web/CHANGES.md b/hledger-web/CHANGES.md index 35bccceb2..4f974d979 100644 --- a/hledger-web/CHANGES.md +++ b/hledger-web/CHANGES.md @@ -9,7 +9,13 @@ __ _____| |__ User-visible changes in hledger-web. See also the hledger changelog. -# 8de85be65 +# 2bce91090 + +Improvements + +- Now builds with GHC 9.2. + +- Uses hledger 1.26. # 1.25 2022-03-04 diff --git a/hledger/CHANGES.md b/hledger/CHANGES.md index fb5fccd9b..7c98a49f5 100644 --- a/hledger/CHANGES.md +++ b/hledger/CHANGES.md @@ -9,47 +9,68 @@ User-visible changes in the hledger command line tool and library. -# 8de85be65 +# 2bce91090 Breaking changes +- Enforce that all files are decoded as UTF-8, ignoring the system locale. + Experimental; real-world testing and feedback is needed. + (#1619, #1834. May also affect #1154, #1033, #708, #536, #73.) + (Stephen Morgan) + Features Improvements -- The accounts command now shows its debug output at a more appropriate level (4). - -- --pivot now supports `status` (to pivot on transaction status). - -- register and aregister have been made faster, by +- `register` and `aregister` have been made faster, by - considering only the first 1000 items for choosing column widths. You can restore the old behaviour (guaranteed alignment - across all items) with the new --align-all flag. + across all items) with the new `--align-all` flag. (#1839, Stephen Morgan) - discarding cost data more aggressively, giving big speedups for large journals with many costs. - (#1828, Stephen Morgan) + (#1828, Stephen Morgan) -- More consistent layout for error messages (Stephen Morgan, Simon Michael) +- Most error messages from the journal reader and the `check` command now use + a consistent layout, with an "Error:" prefix, line and column numbers, + and an excerpt highlighting the problem. Work in progress. + (#1436) (Simon Michael, Stephen Morgan) + +- `hledger check ordereddates` now always checks all transactions + (previously it could be restricted by query arguments). + +- The `--pivot` options now supports a `status` argument, to pivot on transaction status. + +- Update bash completions (Jakob Schöttl) Fixes -- The tags command now also matches accounts declared but not used. - It also has improved command-line help layout. - (#1857) - -- Value reports with --date2 and a report interval (like bal -VM --date2) +- Value reports with `--date2` and a report interval (like `hledger bal -VM --date2`) were failing with a "expected all spans to have an end date" error since 1.22; this is now fixed. (#1851, Stephen Morgan) -- Make sure inferred market prices have the correct sign with total prices. +- In CSV rules, interpolation of a non-existent field like `%999` or `%nosuchfield` + is now ignored (previously it inserted that literal text). + Note this means such an error will not be reported; + Simon chose this as the more convenient behaviour when converting CSV. + Experimental. + (#1803, #1814) (Stephen Morgan) + +- `--infer-market-price` was inferring a negative price when selling. + (#1813, Stephen Morgan) - Allow an escaped forward slash in regular expression account aliases. (#982, Stephen Morgan) +- The `tags` command now also lists tags from unused account declarations. + It also has improved command-line help layout. + (#1857) + +- `hledger accounts` now shows its debug output at a more appropriate level (4). + # 1.25 2022-03-04 Breaking changes