diff --git a/CHANGELOGS.md b/CHANGELOGS.md index 3229da93f..fac6bf37c 100644 --- a/CHANGELOGS.md +++ b/CHANGELOGS.md @@ -14,7 +14,7 @@ Changelogs: Release notes: -- add a new TOC entry and section in site/release-notes.md +- add a new section in site/src/release-notes.md - copy/rewrite/summarise package changelogs - note any other items of interest - list release contributors diff --git a/CHANGES.md b/CHANGES.md index 031113009..be7386d91 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -9,84 +9,57 @@ General changes in the hledger project (and notable all-package releases). For package-specific changes and minor releases, see the hledger package changelogs. -# db0361113 +# 1.24 2021-12-01 -- doc: account types: prioritise short names, hide old syntax +Software -- doc: more compact/accurate directives overview +- bin/hledger-check-fancyassertions.hs: fix ugly assertion parse errors. + (ShrykeWindgrace) -- ;imp: examples/templates/, with one example file set ("basic") +- bin/hledger-check-tagfiles.hs: Update description, clarify wording. + (Pranesh Prakash) -- pkg: bump to latest nightly snapshot to avoid buggy happy 1.21.0 +Docs -- fix: ci: when we can't figure out recent commits, don't check +- Account types: prioritise the short one-letter names, hide the deprecated + legacy syntax. -- Update description of hledger-check-tagfiles.hs (Pranesh Prakash) - Made it clear that it's a `/` and not "containing / exist" (i.e., containing or exist). +- Directives: a more compact and accurate overview. -- ;imp: examples: set account display order in bcexamples +- examples/templates/basic: A new starter file set, and a place to collect them. -- ;imp: tools: make throughput prints quick throughput stats at various file sizes +- Expose more developer docs as separate web pages: + CHANGELOGS, COMMITS, RELEASING, etc. -- ;imp: perf: Ledger-friendly bench-ledger.sh, for comparative benchmarking +- Fix a link to developer workflows. (Joaquin "Florius" Azcarate) -- ci: fall back on checking last 5 commit messages, instead of 20 - This will allow CI status to recover faster when a bad commit message - is accidentally merged. In some cases (eg force pushes of PRs with - more than 5 commits) not all commit messages will be checked at all - times. +Process -- pkg: Bump stack lts and nightlies. (Stephen Morgan) +- PR template: Fix our github PR template to use proper comment syntax, + and link to more relevant docs. + (toonn) -- ; Fix the link to the developer workdflows (Joaquin "Florius" Azcarate) +- cabal.project: Drop obsolete compatibility comment. + (#1365, toonn) -- imp: hledger-check-fancyassertions.hs: use megaparsec's prettyprinter for assertion parse errors (ShrykeWindgrace) +- Bump default stackage snapshot to one avoiding buggy happy version. -- ; PR-template: Change comment syntax (toonn) - The # syntax for comments results in all the lines being rendered as - separate headers because it's markdown syntax for titles. I believe the - markdown custom is to use ``. +- bin/changelog: a new helper making changelog edits more pleasant. -- ; PR-template: Update dev docs URL (toonn) - The URL in the PR template redirects to a general contributing guide, - which is useful, but it's hard to see the trees for the forest when just - looking for PR and commit guidelines. +- make throughput{,-dev,-EXE}: reports transactions per second for a range of + file sizes with the hledger in PATH, hledger dev build, or named hledger + executable. -- ; cabal.project: Drop compatibility comment (toonn) - The offending syntax is no longer used so the comment can be removed - too. Ideally `allow-newer` isn't used in the project's setup. The - problem should rather be fixed by adjusting constraints, though these - adjustments may need to be made in dependencies upstream. +- make install-as-FOO: build executables and save as bin/hledger*-FOO - Fixes #1365 +- perf: bench-ledger.sh for comparative benchmarking with Ledger. -- ;make: install-as-FOO: build executables and save as bin/hledger*-FOO +- CI: commitlint: be more forgiving when we can't figure out recent commits + (don't check any). -- ;doc: orgfiles: disable smart dashes in another way +- CI: commitlint: recognise any commit starting with ‘Merge’ as a merge commit + (and ignore it). (Stephen Morgan) -- ci: Recognise any commit starting with ‘Merge’ as a merge commit, which is ignored by commitlint. (Stephen Morgan) - -- ;doc: merge doc/README with dev docs - -- ;doc: add page TOCs to more dev docs - -- ;doc: move more content out of CONTRIBUTING - -- ;doc: separate CHANGELOGS, COMMITS docs - -- ;doc: ACHIEVEMENTS: format, update - -- ;tools: make site(-watch): add orgfiles - -- ;doc: BACKLOG: updates; all cli items added - -- ;doc: RELEASING: updates - -- ;doc: CONTRIBUTING: updates, components -> topics - -- ;tools: make copy-exe*: name them -SUFF not .SUFF - Breaks my usual convention of hledger-foo being an addon command, but - -VERSION is too common (and matches the make target that you type). # 1.23 2021-09-21 diff --git a/hledger-lib/CHANGES.md b/hledger-lib/CHANGES.md index c11dff02a..ca668cff3 100644 --- a/hledger-lib/CHANGES.md +++ b/hledger-lib/CHANGES.md @@ -9,9 +9,7 @@ Internal/api/developer-ish changes in the hledger-lib (and hledger) packages. For user-visible changes, see the hledger package changelog. -# 7e47d3645 - -Features +# 1.24 2021-12-01 Improvements @@ -43,8 +41,6 @@ Improvements - Allow megaparsec 9.2. -Fixes - # 1.23 2021-09-21 - Require base >=4.11, prevent red squares on Hackage's build matrix. diff --git a/hledger-ui/CHANGES.md b/hledger-ui/CHANGES.md index 84ca252e3..8d6460f1c 100644 --- a/hledger-ui/CHANGES.md +++ b/hledger-ui/CHANGES.md @@ -9,13 +9,13 @@ User-visible changes in hledger-ui. See also the hledger changelog. -# 791f4655d +# 1.24 2021-12-01 Features - hledger-ui can now be controlled with mouse or touchpad. - Click to enter things, click left margin or bottom blank area to exit them, - and use mouse wheel / swipe to scroll. + Click to enter things, click left margin or bottom blank area to return to + previous screen, and use mouse wheel / swipe to scroll. - In addition to accounts with postings, hledger-ui now also shows declared accounts, even if they are empty (just leaf accounts, not diff --git a/hledger-web/CHANGES.md b/hledger-web/CHANGES.md index 61679cc17..2858f6593 100644 --- a/hledger-web/CHANGES.md +++ b/hledger-web/CHANGES.md @@ -9,16 +9,12 @@ __ _____| |__ User-visible changes in hledger-web. See also the hledger changelog. -# 791f4655d - -Features +# 1.24 2021-12-01 Improvements - Allow megaparsec 9.2 -Fixes - # 1.23 2021-09-21 diff --git a/hledger/CHANGES.md b/hledger/CHANGES.md index 5bdfd21cb..27bc3285c 100644 --- a/hledger/CHANGES.md +++ b/hledger/CHANGES.md @@ -9,30 +9,12 @@ User-visible changes in the hledger command line tool and library. -# 791f4655d +# 1.24 2021-12-01 Features -- The balance commands have a new --declared flag, causing them to - include leaf (ie, non-parent) accounts declared by account directives, - even if they contain no transactions yet. Together with -E, this shows - a balance for both used and declared accounts. - The idea is to be able to see a useful "complete" balance report, even - when you don't have transactions in all of your declared accounts yet. - (#1765) - -- journal files now support a `decimal-mark` directive as a more - principled way to specify the decimal character in use in that file, - ensuring accurate number parsing. - (#1670, Lawrence Wu) - -Improvements - -- The stats command now shows rough but useful performance stats: run - time and processing speed in transactions per second. - -- balance commands no longer elide too-wide amounts by default. And, - they provide more control over how multicommodity amounts are displayed. +- balance commands provide more control over how multicommodity amounts + are displayed. (And they no longer elide too-wide amounts by default.) The --commodity-column flag has been deprecated and replaced by a new --layout option, with three values: @@ -42,6 +24,24 @@ Improvements (Stephen Morgan) +- The balance commands have a new `--declared` flag, causing them to + include leaf (ie, non-parent) accounts declared by account directives, + even if they contain no transactions yet. Together with `-E`, this shows + a balance for both used and declared accounts. + The idea is to be able to see a useful "complete" balance report, even + when you don't have transactions in all of your declared accounts yet. + (#1765) + +- journal files now support a `decimal-mark` directive as a more + principled way (than `commodity` directives) to specify the decimal character + in use in that file, to ensure accurate number parsing. + (#1670, Lawrence Wu) + +Improvements + +- The stats command now shows rough but useful performance stats: run + time and processing speed in transactions per second. + - balance: support the --related flag, like register, showing the other postings from the transactions. (#1469, Stephen Morgan)