From d9c512deeeae1cc065a7ca084e00bce34f22be6d Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 29 May 2025 14:16:22 -1000 Subject: [PATCH] ;doc: changelogs --- CHANGES.md | 53 ++++++++++++++++- hledger-lib/CHANGES.md | 36 ++++++++++++ hledger-ui/CHANGES.md | 21 +++++++ hledger-web/CHANGES.md | 29 +++++++++ hledger/CHANGES.md | 129 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 265 insertions(+), 3 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 187e41c6a..0af8fb633 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -7,9 +7,6 @@ |_| |__/ Docs -(some overlap with hledger changelog; doc updates are mostly mentioned in that one since it's more visible) - -Scripts/addons Infrastructure/Misc @@ -19,6 +16,56 @@ General changes in the hledger project. For package-specific changes, see the hledger package changelogs. +# 4913c222 + +Docs + +- Updated: + FILES, + FINANCE, + ISSUES, + PULLREQUESTS, + REGRESSIONS, + RELEASING, + ghrelnotes, + relnotes + +Infrastructure/Misc + +- issue labels updates, `severity*` -> `annoyance*`, `impact*` -> `affects*` +- new shortcut urls: assignedprs.hledger.org, unassignedprs.hledger.org +- clean up LICENSE files, main module licensing headers, add AUTHORS.md, try to fix github license detection +- cabal files now specify GPLv3+ exactly. [#2359] +- building the hledger packages now requires at least Cabal 2.2+ or stack built with Cabal 2.2+ (was 1.12+). +- avoid a ghci warning if :rmain is defined in user's config. +- simplify stack yaml file names +- workflows updates: + - binaries\*: simplify, cleanup + - binaries-linux-x64: install ghcup only if not cached; fix cache + - windows: use preinstalled stack + - docker: draft of a docker image build/publish workflow (Doug Goldstein, [#2002]) + - nightly: adds latest binaries to the "nightly" release +- tools updated: + binaries, + devtag-push, + ghnightly, + ghnightly-bin, + ghnightlynotes-push, + ghrel, + ghrelease-upload, + ghrelnotes-push, + ghrun, + ghrun-id, + ghrun-open, + ghruns, + ghruns-download, + ghruns-open, + hackageupload, + nightly, + nightlybin, + nightlytag + + # 1.42.2 2025-05-16 Docs diff --git a/hledger-lib/CHANGES.md b/hledger-lib/CHANGES.md index 3d690c0e0..cdaecd895 100644 --- a/hledger-lib/CHANGES.md +++ b/hledger-lib/CHANGES.md @@ -22,6 +22,42 @@ Internal/api/developer-ish changes in the hledger-lib (and hledger) packages. For user-visible changes, see the hledger package changelog. +# 4913c222 + +- Support GHC 9.12. + +- Fix doctest suite with ghc-8.10.7 (Thomas Miedema) + +- Drop base-compat dependency (Thomas Miedema) + +- Added NFData instances for Journal and subcomponents. (Stephen Morgan) + +- Hledger.Data.Dates: + - renamed parsedateM -> parsedate. + M makes me think of monad and is awkward to type for this common helper. + Maybe is expected for a parser. + - parsedate now also accepts YYYYMMDD format, for convenience in ghci and for parseHledgerVersion. + This is more permissive, now parsing many integers successfully; hopefully that won't be a problem. + I noted but did not document two user-facing uses, which now also accept YYYYMMDD dates: + --value's argument, and import's .latest files. + +- Hledger.Data.Journal: journalCommoditiesUsed + +- Hledger.Read: more ways to read the default journal: + defaultJournalWith, defaultJournalSafely, defaultJournalSafelyWith + +- Hledger.Utils.Debug: + - Provide simpler, more consistent dbg* names. + - A few cases of hledger/hledger-ui debug output which were always + traced to stderr or always logged to a file, now consistently follow + the policy on whether to trace or log. + +- Hledger.Utils.IO: + - exitOnError, a helper to clean up unicode errors and GHC error output generally. + - make parseYN(A) total + - export findPager, getHomeSafe + + # 1.42.2 2025-05-16 - Require extra >= 1.7.11, fixing the stack8.10.yaml build. (Thomas Miedema) diff --git a/hledger-ui/CHANGES.md b/hledger-ui/CHANGES.md index a9e387e3c..2cd6f8ac8 100644 --- a/hledger-ui/CHANGES.md +++ b/hledger-ui/CHANGES.md @@ -22,6 +22,27 @@ User-visible changes in hledger-ui. See also the hledger changelog. +# 4913c222 + +Fixes + +- Require fsnotify >=0.4.2.0, which fixes some events being ignored on mac, + possibly making hledger-ui --watch more reliable in this regard. + +- Require extra >=1.7.11, possibly fixing the stack810.yaml build. (Thomas Miedema) + +Improvements + +- CLI error messages now have consistent clean format independent of GHC version. [#2367] + +- Support GHC 9.12. + +Docs + +- Update --watch docs. +- Drop obsolete mention of Windows non-support. + + # 1.42.2 2025-05-16 Fixes diff --git a/hledger-web/CHANGES.md b/hledger-web/CHANGES.md index fa57d0ee0..984df0e14 100644 --- a/hledger-web/CHANGES.md +++ b/hledger-web/CHANGES.md @@ -22,6 +22,35 @@ User-visible changes in hledger-web. See also the hledger changelog. +# 4913c222 + +Features + +- Serve openapi.json, documenting the hledger-web HTTP API so that tools + like open-webui and LLMs can query hledger-web for context. + (Ben Sima) + +Improvements + +- The search help popup has been updated, and now shows the hledger-web version. + +- The default "serve and browse" mode now has an explicit `--serve-browse` mode flag, for consistency. + +- The old `--server` flag is now deprecated and hidden. Use `--serve` instead. + +- CLI error messages now have consistent clean format independent of GHC version. [#2367] + +- Fix capitalisation in Sandstorm app metadata. + +- Support GHC 9.12. + +- Drop base-compat dependency (Thomas Miedema) + +Docs + +- Fix outdated PERMISSIONS doc. + + # 1.42.2 2025-05-16 Fixes diff --git a/hledger/CHANGES.md b/hledger/CHANGES.md index 198e882bc..80d28ff2b 100644 --- a/hledger/CHANGES.md +++ b/hledger/CHANGES.md @@ -15,6 +15,8 @@ Improvements Docs +Examples + Scripts/addons API @@ -23,6 +25,133 @@ API User-visible changes in the hledger command line tool and library. +# 4913c222 + +## Breaking changes + +- Timeclock format now supports multiple simultaneous clocked-in sessions. + A clockout entry can reference the account name of the clockin it is ending, + otherwise it will end the most recent clockin. + + This is a potentially breaking change, because we previously ignored + the description on clockout entries. For now, you can restore the + old behaviour by adding the `--timeclock-old` flag. This may be + removed later, so if you needed it, please let us know! + (Michael Rees, [#2141]) + +## Fixes + +- For a long time, hledger docs stated that hledger's input and output had to be UTF-8 encoded. + In fact this was wrong; hledger has always used the system locale's encoding for both. + Docs like [Install: Text encoding](install.md#text-encoding) + and [hledger: Text encoding](hledger.md#text-encoding) + have been updated. + [#2394] + +- Some boolean queries involving `amt:` or `cur:` did not match correctly; now they do. + (Simon Michael, Stephen Morgan, [#2371], [#2373], [#2387]) + +- The `roi` command has fixed a bug with PnL attributed to the wrong period. + (Dmitry Astapov, [#2391]) + +- CLI error messages now have consistent format independent of the GHC + version hledger was compiled with. [#2367] + +## Features + +- A new `setup` command checks your hledger installation and shows information + useful for troubleshooting. It will do more in future. + For now, `setup` should be reliable and accurate; + please test it on all your machines and share the results with us. + Experimental. + + When you run this command, hledger attempts one HTTP request, with a 10s timeout, + to hledger.org, to detect the current release version. + +- New `any:"BOOLEANQUERY"` and `all:"BOOLEANQUERY"` queries can be + used with transaction-matching commands like `print` and `import`. + + Unlike `expr:"BOOLEANQUERY"`, where the parts of the boolean query + are allowed to match different postings in the transaction, + with `any:` and `all:` the entire boolean query must match match a single posting. + `any:` matches the transaction if any posting is matched, + `all:` matches the transaction if all postings are matched. + +- The `add` command now allows balance assertions to be added, after an amount. + Also, whenever you enter an amount, it now checks the journal's balance assertions + and will not allow adding an amount that would cause assertion failure + (unless you use the `-I/--ignore-assertions` flag). + (Michael Rees, [#2355], [#2356]) + +- The hledger-print-location script, which shows transactions' file positions, + is now built in to `print` as the `--location` flag. + (Sam Salmahri, [#2368]) + +## Improvements + +- Core data types are now more strict, which in some cases reduces memory and time usage by up to 15%. + (Stephen Morgan, [#2381], [#2385], [#2387]) + +- Config files (and maybe timedot files) no longer require a final newline. + +- In journal format, `include` directives can now have same-line comments. + +- CSV `if` rules now produce more `--debug=2` output, useful for troubleshooting. + +- CSV debug output now displays records as the `if` matchers see them. + (Comma separated and with quotes and outer whitespace removed.) + +- A number of error messages have been updated to show a consistent format. + (reading a nonexistent data file, + reading an unsafe dotted file name on Windows, + demo not found, + demo asciinema error, + diff bad arguments, + print --match with no match, + register --match with no match, + roi with no investment transactions). + [#2367] + +- Support GHC 9.12. + +## Docs + +- Account types: rewrite +- Assertions and multiple files: edits +- Balance assertions and multiple files +- balance: edits +- Beancount output: edits +- check: edits +- Config file: drop the s +- CSV: clarify that CSV means delimiter-separated values, link to wikipedia DSV page +- CSV:description field: fix link [hledger_site#133] +- Fix broken hledger-iadd link +- Fix various broken "Commodity display style" links (JB Rainsberger, Simon Michael, [hledger_site/#132]) +- How CSV rules are evaluated: clarify +- Journal: cheatsheet edits +- print: simplify [#2368] +- Queries: discuss transaction vs posting queries; cleanups +- Queries: fix the explanation of boolean queries and space-separated terms + +## Examples + +- examples/csv/nps.csv.sh updated (Pranesh Prakash) +- examples/forecast-budget* -> examples/goal-budget* +- examples/i18n/\*.journal: top level account declarations in several languages. +- examples/quickstart.journal: the quickstart journal from the home page + +## Scripts/addons + +- bin/balance-as-budget-multi.hs (Dmitry Astapov) +- bin/bashrc: command alias updates +- bin/hledger-sankeymatic + +## API + +- Hledger.Cli.Conf: make getConf total, add getConf' +- Hledger.Cli.Version: add more version helpers, rename HledgerBinaryInfo + + # 1.42.2 2025-05-16 Fixes