;doc: draft changelogs

CHANGES.md

@@ -9,6 +9,81 @@
 General changes in the hledger project (and notable all-package releases).
 For package-specific changes and minor releases, see the hledger package changelogs.
 
+# db0361113
+
+- ;imp: examples/templates/, with one example file set ("basic")
+
+- pkg: bump to latest nightly snapshot to avoid buggy happy 1.21.0
+
+- fix: ci: when we can't figure out recent commits, don't check
+
+- 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). 
+
+- ;imp: examples: set account display order in bcexamples
+
+- ;imp: tools: make throughput prints quick throughput stats at various file sizes
+
+- ;imp: perf: Ledger-friendly bench-ledger.sh, for comparative benchmarking
+
+- 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.
+
+- pkg: Bump stack lts and nightlies. (Stephen Morgan)
+
+- ; Fix the link to the developer workdflows (Joaquin "Florius" Azcarate)
+
+- imp: hledger-check-fancyassertions.hs: use megaparsec's prettyprinter for assertion parse errors (ShrykeWindgrace)
+
+- ; 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 `<!-- HTML comments -->`.
+
+- ; 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.
+
+- ; 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.
+
+  Fixes #1365
+
+- ;make: install-as-FOO: build executables and save as bin/hledger*-FOO
+
+- ;doc: orgfiles: disable smart dashes in another way
+
+- 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
 
 Software:

hledger-lib/CHANGES.md

@@ -9,8 +9,43 @@
 Internal/api/developer-ish changes in the hledger-lib (and hledger) packages.
 For user-visible changes, see the hledger package changelog.
 
-# 1.23 2021-09-21
+# 7e47d3645
 
+- pkg: Use maximumBound instead of maximumDef to avoid deprecation warnings in safe-0.3.18. (Stephen Morgan)
+
+- lib!: Semigroup instance of PeriodicReportRow and PeriodicReport now preserves first prrName, rather than the second. (Stephen Morgan)
+  Previously the second name would be taken, ignoring the first.
+
+- lib: Add Bifunctor instances for PeriodicReport and PeriodicReportRow. (Stephen Morgan)
+
+- pkg: Drop base-compat-batteries dependency. (Stephen Morgan)
+  Our supported stackage versions are now new enough that we don't need
+  any of the compatibility features anymore.
+
+- cln: Move posting rendering functions into Hledger.Data.Posting. Replace showPosting with a wrapper around postingAsLines. (Stephen Morgan)
+  The functions textConcat(Top|Bottom)Padded are no longer used anywhere
+  in the code base, and can be removed if desired.
+
+  This produces slightly different output for showPosting, in particular
+  it no longer displays the transaction date. However, this has been
+  marked as ‘for debugging only’ for a while, and is only used in
+  hledger-check-fancy assertions. The output there is still acceptable.
+
+- ref!: postingDateOrDate2, transactionDateOrDate2, whichDateFromOpts -> whichDate (#1731)
+
+- ;pkg: allow megaparsec 9.2
+
+- ref: Add new helper functions journalValueAndFilterPostings(With)?. (Stephen Morgan)
+  Combining valuation with filtration is subtle and error-prone (see e.g. #1625).
+  We have to do in in both MultiBalanceReport and PostingsReport, where it
+  is done in slightly different ways. This refactors this functionality
+  into separate functions which are called in both reports, for uniform
+  behaviour.
+
+- imp!: value: For register reports with no reporting interval and --value=end, 
+  historical reports should be valued at journal/report end date. (Stephen Morgan)
+
+# 1.23 2021-09-21
 - Require base >=4.11, prevent red squares on Hackage's build matrix.
 
 Much code cleanup and reorganisation, such as:

hledger-ui/CHANGES.md

@@ -9,6 +9,46 @@
 User-visible changes in hledger-ui.
 See also the hledger changelog.
 
+# 791f4655d
+
+- imp: ui: Z -> z for easier zero toggling
+  Z remains supported as a hidden legacy key.
+
+- imp: ui: also show declared leaf accounts (when showing zeros)
+  Similar to (and motivating) balance --declared, the goal is to
+  show a useful list of accounts when all you have is some starter
+  files with account declarations.
+
+- imp: ui: -w short flag for --watch
+
+- imp: ui: Display an error message on invalid regexp, rather than silently ignoring. (#1394) (Stephen Morgan)
+
+- fix: ui: scroll selection to middle on first entry, also
+  The viewport doesn't exist until after first render, and scrollSelectionToMiddle didn't need it; viewportScroll queues up events for it.
+  https://github.com/jtdaugherty/brick/issues/349
+
+- feat: Mouse/touchpad support.
+  Mouse wheel scrolls accounts & register screens,
+  click things to enter them, 
+  click left margin or bottom blank area to go back.
+
+- dev: Use realLength from doclayout instead of strWidth and textWidth. (#895) (Stephen Morgan)
+  This gives us more accurate string length calculations. In particular,
+  it handles emoji and other scripts properly.
+
+- pkg: Drop base-compat-batteries dependency. (Stephen Morgan)
+  Our supported stackage versions are now new enough that we don't need
+  any of the compatibility features anymore.
+
+- Allow megaparsec 9.2
+
+Features
+
+Improvements
+
+Fixes
+
+
 # 1.23 2021-09-21
 
 Improvements

hledger-web/CHANGES.md

@@ -9,6 +9,10 @@ __      _____| |__
 User-visible changes in hledger-web.
 See also the hledger changelog.
 
+# 791f4655d
+
+- Allow megaparsec 9.2
+
 # 1.23 2021-09-21
 
 Improvements

hledger/CHANGES.md

@@ -9,6 +9,90 @@
 User-visible changes in the hledger command line tool and library.
 
 
+# 791f4655d
+
+- fix: prices: Do not include zero amounts when calculating amounts for balance assignments. (#1736) (Stephen Morgan)
+  This is not usually a problem, but can get in the way of auto-inferring prices.
+
+- fix: csv: Successfully parse empty csv file. (#1183) (Stephen Morgan)
+
+- imp: balcmds: support --declared on bs/cf/is also (#1765)
+
+- feat: bal: with --declared, include declared leaf accounts (#1765)
+  Together with -E, this shows a balance for both used and declared
+  accounts (excluding empty parent accounts, which are usually not
+  wanted in list-mode reports).
+
+  This is somewhat consistent with --declared in the accounts and payees
+  commands, except for the leaf account restriction.
+
+  The idea of this 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. I mainly want this for hledger-ui, but there's no harm
+  in exposing it in the balance CLI as well.
+
+- ;imp: doc: account types: prioritise short names, hide old syntax
+
+- imp: doc: more compact/accurate directives overview
+
+- imp: stats: also show run time and throughput
+  CliOpts has a new field, progstarttime_.
+
+  Currently the new stats are always printed on stdout, ignoring --output-file/--output-format.
+
+- fix: balance: Balance reports with --depth=0 should report on true values, not zero everywhere. (#1761) (Stephen Morgan)
+
+- feat: docs for decimal-mark (#1670, #1726)
+
+- imp: journal: support decimal-mark directive in journal files (Lawrence)
+  To match csv-rule and override amount-style as described in
+  https://github.com/simonmichael/hledger/issues/1670
+
+- ;imp: bal --layout: streamline help more (#1751)
+
+- imp!: balance: Stop eliding long amounts. (#1739) (Stephen Morgan)
+  This feature has caused a lot of confusion, and we now have better ways
+  of making sure columns don't get too wide.
+
+- imp: balance: Implement multi-line display for multicommodity balance reports. (Stephen Morgan)
+  This allows more control over how multicommodity amounts are displayed.
+  In addition to the default single-line display, and the recent commodity
+  column display, we now have multi-line display. This is controlled by
+  the --layout option, which has possible values "wide", "tall", and
+  "bare". The --commodity-column option has been hidden, but is equivalent
+  to --layout=bare.
+
+- fix: prices: Do not try to generate prices when there would be a zero denominator. (Stephen Morgan)
+  Also correctly generate reverse prices for zero amounts.
+
+- fix: csv: Handle multiple zero amounts in postings in csv files. (#1733) (Stephen Morgan)
+
+- imp: balance: Allow --related flag for balance reports. (#1469) (Stephen Morgan)
+
+- fix: balance: Balance reports should consider date: queries when calculating report span with --date2. (#1745) (Stephen Morgan)
+
+- fix: print: auto: The print command should always display inferred amounts for --auto generated postings. (#1276) (Stephen Morgan)
+
+- pkg: Drop base-compat-batteries dependency. (Stephen Morgan)
+  Our supported stackage versions are now new enough that we don't need
+  any of the compatibility features anymore.
+
+- fix: roi: use posting dates when available, honor --date2 (Dmitry Astapov)
+  This will not change the results computed for the typical use-case,
+  just makes "roi" more thorough/consistent by supporting posting dates
+  when they are provided.
+
+- areg: begin respecting --date2: show txns' date2 (#1731)
+
+- ;pkg: allow megaparsec 9.2
+
+- timedot: a D default commodity (and style) is applied to timedot aounts
+  This means they can be priced and converted.
+
+- imp!: value: For register reports with no reporting interval and --value=end, historical reports should be valued at journal/report end date. (Stephen Morgan)
+
+- imp: cli: Allow general optional argument flags (--pretty and --forecast) to be moved after the subcommand name. (Stephen Morgan)
+
 # 1.23 2021-09-21
 
 Features