;doc: draft changelogs from TWIH (site/src/news.md)

This commit is contained in:
Simon Michael 2023-12-01 06:53:06 -10:00
parent d652535632
commit 938b89ecab
2 changed files with 179 additions and 0 deletions

View File

@ -18,6 +18,114 @@ Infrastructure
General changes in the hledger project.
For package-specific changes, see the hledger package changelogs.
Docs
- hledger manual:
- Updated:
- Decimal marks, digit group marks
- commodity directive
- CSV > if table (#2107)
- Timedot
- Added:
- Amount formatting, parseability: an explanation of trailing decimal marks
and number formatting differences between reports. (#2115)
- Ledger: more notes on commodity directives, from chat.
- Ledger: interoperating tips updates, more about commodity directives and balance assertions.
- Checking for errors: tips on enforcing account lifetimes, from reddit,
and on minimising diffs in reports, from mail list.
- As part of Precisiongeddon, I started expanding hledger's "code docs", in the Hledger module's haddock.
I spent time learning how to navigate Haddock and producing a fast-feedback authoring workflow (`make haddock-watch`).
And documented a bunch of "jargon" terms, and how we handle precision and display styles.
- The "Regular expressions" manual section has been rewritten and now has examples:
<https://hledger.org/dev/hledger.html#regular-expressions>.
- Unmentioned last week: I added a News page on hledger.org as a stable home
for This Week In Hledger and other news updates.
- moved regression bounty info to <https://hledger.org/REGRESSIONS.html>
- hledger manual > Journal > Commodity display style: rewritten
- hledger manual > aregister, hledger-ui manual > Register screen: note how separately-dated postings get combined
- [How to record journal entries](https://hledger.org/how-to-record.html#how-to-record-journal-entries)
- [hledgermatic](https://hledger.org/hledgermatic.html#hledgermatic) , a simple up-to-date workflow
- Cleanups: Common workflows, Simon's old setup
- All hledger docs now use the `cli` class instead of `shell` for command-line examples,
avoiding inaccurate highlighting.
- Videos: reorder hledger fan videos.
- REGRESSIONS: cleanups, mention real names.
Examples
- justfile: forecast-import: show but don't consume future-dated forecast transactions
- hledger-report1: a custom compound report script, haskell and bash versions
Tools
- tools: ghci :rmain - like :main, but reloads first, useful eg when changing --debug level
Ops
- Updated the stars.hledger.org redirect (we have reached the top 30 Haskell projects by github stars 🌟 🎉).
- Fixed a problem with cloudflare authentication that was preventing
automatic TLS certificate renewal on hledger.org.
- Committed hledger.org's caddy config.
- Fixed the hledger.org webhook that was not updating the site on git push.
- Enabled https for "code.hledger.org" and "site.hledger.org" short urls.
- CI (continuous integration) workflows on github have been optimised a bit:
- Scheduled weekly builds have been disabled, as they were propagating
to forks and running wastefully there in some cases.
- Some repeated rebuilding of the hledger-lib and hledger packages
that seems unnecessary has been stopped.
- hledger-ui no longer builds its modules twice.
- Haddock testing has been moved to the release workflows to save time.
- Set up a self-hosted Sandstorm server and learned how to configure it.
- Set up a public hledger-web instance in it: sandbox.hledger.org.
Unlike <https://demo.hledger.org>, and until the spammers find it,
sandbox is fully writable - use it as a pastebin for examples, eg.
- renamed main CI workflow and branch to "ci"
- updated and committed hledger.org's caddy config and short urls (redirects)
- there's now an easy short url for trying out the hledger-web app on Sandstorm: <https://sandstorm.hledger.org>.
Finance
- Updated project finance scripts, regenerated the project ledger with
consistent precisions in assertions, updated it with the last few
months of data from Open Collective.
# 1.31 2023-09-03
Scripts/addons

View File

@ -21,6 +21,77 @@ API
User-visible changes in the hledger command line tool and library.
Breaking changes
- This week I completed the months-long yak shave that became
Precisiongeddon, and it has landed in master; see
<https://github.com/simonmichael/hledger/pull/2111> for details.
Heads up: this can change default precisions shown especially by
cost and value reports - all for the better hopefully.
Features
- The `print` command has a new `beancount` output format for exporting to Beancount.
- Timedot format supports a new letters syntax for easier tagged time logging. (#2116)
- Add tsv output (#869) (Peter Sagerson)
- import: interpolate regex matches in field templates (#2009) (Jonathan Dowland)
- print: add --round option for more control of precisions (#2085)
- [feat: balance: Add only-summary flag (#1012) #2086](https://github.com/simonmichael/hledger/pull/2086) (Stephen Morgan)
- [feat: CSV rule negation #2088](https://github.com/simonmichael/hledger/pull/2088) (bobobo1618)
Improvements
- Journal format now accepts lot costs with spaces after `{`, improving Ledger compatibility.
- A new hledger user pointed out in chat out that -s/--strict mode
didn't work with the import command. This exposed a bug (#2113) and
led to some reworking of the API in Hledger.Read. Until now, when
reading multiple files, -s/--strict checks were performed for each
individual file, causing spurious failures, with import and other
commands. Now strict checks are done only once, for the overall
journal. Also, the import command now only updates .latest files at
the end of a successful run (after successfully passing strict
checks and after updating the journal file).
- web: access control UX cleanups: replace --capabilities and --capabilities-header with --allow, and validate it before starting the app (#834)
- web: sandstorm web app cleanups; rename/reorder roles & permissions
- Jacob Weisz has updated the hledger-web app on Sandstorm
- [imp: web: include account declaration info in accounts JSON #2097](https://github.com/simonmichael/hledger/pull/2097) (S. Zeid)
Fixes
- Non-print-like reports no longer add trailing decimal marks (a regression in 1.31).
Clarified the policy on number formatting adjustments made in certain reports/output formats. (#2115)
- `tag:` queries now work when reading CSV files. (#2114)
- `-o`/`--outputfile` with a .json or .sql extension now properly selects those formats.
- amounts in value reports can sometimes be shown unstyled / with zero decimal digits,
<https://github.com/simonmichael/hledger/issues/2105>
- auto postings break redundant equity/cost detection and transaction balancing,
<https://github.com/simonmichael/hledger/issues/2110>
- demo: avoid a bug in asciinema 2.3.0, and improve the error message when asciinema fails (#2094)
- web: fix broken "File format help" link in the edit form (#2103)
- balance-assigned amounts affect commodity styles again (#2091, regression in 1.30)
- timedot: parse unitful quantities more accurately (#2096)
Breaking changes
Features