mirror of
https://github.com/simonmichael/hledger.git
synced 2024-12-27 04:13:11 +03:00
;doc: merge 1.34 release docs
This commit is contained in:
Simon Michael
parent
2448744ce9
commit
8f24fad909
25
CHANGES.md
25
CHANGES.md
@ -19,22 +19,31 @@ For package-specific changes, see the hledger package changelogs.
|
||||
|
||||
|
||||
# 0fedc35a9
|
||||
# 1.34 2024-06-01
|
||||
|
||||
Docs
|
||||
|
||||
- move release notes from site repo to the main hledger repo
|
||||
- move release notes from the hledger_site repo to the main hledger repo
|
||||
- github release notes: show the release notes, hide the install instructions by default
|
||||
- github release notes: improve windows install commands
|
||||
- dev doc updates; new Developer FAQ, Contributor Quick Start updates
|
||||
- examples: csv: vanguard, fidelity, paypal updates
|
||||
- github release notes: start mentioning github usernames, enabling the Contributors avatar list
|
||||
- dev docs: new Developer FAQ, Contributor Quick Start updates
|
||||
|
||||
Scripts/addons
|
||||
|
||||
Infrastructure/Misc
|
||||
- `hledger-install.sh` now uses stackage nightly, and a failure on non-Windows platforms has been fixed.
|
||||
|
||||
Infrastructure/misc
|
||||
|
||||
- A new `release` workflow creates github releases, uploads release binaries and generates release notes.
|
||||
- There is a new `oldest` workflow for testing the oldest GHC we support (currently 8.10.7).
|
||||
- The `binaries-mac-x64` workflow has been bumped from GHC 9.4 to 9.8.
|
||||
- The master branch's `ci` workflow has been updated to Ubuntu 24.04
|
||||
and uses the preinstalled GHC & stack, saving some work.
|
||||
- `md-issue-refs` helps generate markdown issue links.
|
||||
- `relnotes.hs` helps generate release notes from changelogs.
|
||||
- The project `Makefile` has now been fully replaced by `Justfile`.
|
||||
|
||||
- Fully replace the main Makefile with Justfile
|
||||
- md-issue-refs: markdown issue links helper
|
||||
- relnotes.hs: generate release notes from changelogs
|
||||
- CI workflow updates
|
||||
|
||||
# 1.33 2024-04-18
|
||||
|
||||
|
||||
10
doc/ANNOUNCE
10
doc/ANNOUNCE
@ -1,15 +1,15 @@
|
||||
I'm pleased to announce hledger 1.33.1, with several fixes,
|
||||
installability improvements, and doc updates.
|
||||
I'm pleased to announce hledger 1.34, with cli cleanups, tldr
|
||||
integration, and ghc-debug support.
|
||||
|
||||
- https://github.com/simonmichael/hledger/releases/1.33.1
|
||||
- https://hledger.org/relnotes.html#2024-05-02-hledger-1331
|
||||
- https://github.com/simonmichael/hledger/releases/1.34
|
||||
- https://hledger.org/relnotes.html#2024-06-01-hledger-134
|
||||
- https://hledger.org/install
|
||||
|
||||
Best,
|
||||
-Simon
|
||||
|
||||
|
||||
hledger is free, fast, robust, multicurrency, double-entry,
|
||||
hledger is free, robust, friendly, multicurrency, double-entry,
|
||||
plain text accounting software for unix, mac, windows, and the web.
|
||||
Written in Haskell for reliability and longevity,
|
||||
it is built around human-readable, version-controllable plain text files,
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
I'm pleased to announce hledger 1.33.1, with several fixes,
|
||||
installability improvements, and doc updates.
|
||||
I'm pleased to announce hledger 1.34, with cli cleanups, tldr
|
||||
integration, and ghc-debug support.
|
||||
|
||||
- https://github.com/simonmichael/hledger/releases/1.33.1
|
||||
- https://hledger.org/relnotes.html#2024-05-02-hledger-1331
|
||||
- https://github.com/simonmichael/hledger/releases/1.34
|
||||
- https://hledger.org/relnotes.html#2024-06-01-hledger-134
|
||||
- https://hledger.org/install
|
||||
|
||||
#hledger is free, fast, robust, multicurrency, double-entry,
|
||||
#hledger is free, robust, friendly, multicurrency, double-entry,
|
||||
#PlainTextAccounting software for unix, mac, windows, and the web,
|
||||
written in #Haskell for reliability and longevity.
|
||||
For help, join our chat or mail list: https://hledger.org/support
|
||||
For help, join the chat, forum or mail list: https://hledger.org/support
|
||||
|
||||
#PersonalFinance
|
||||
|
||||
181
doc/relnotes.md
181
doc/relnotes.md
@ -74,6 +74,187 @@ Changes in hledger-install.sh are shown
|
||||
|
||||
|
||||
|
||||
## 2024-06-01 hledger-1.34
|
||||
|
||||
|
||||
### hledger 1.34
|
||||
|
||||
|
||||
Breaking changes
|
||||
|
||||
- `check ordereddates` no longer supports `--date2`.
|
||||
Also (not a breaking change): `--date2` and secondary dates are now officially
|
||||
[deprecated](https://hledger.org/1.34/hledger.html#secondary-dates) in hledger,
|
||||
though kept for compatibility.
|
||||
|
||||
Features
|
||||
|
||||
- You can now get a quick list of example command lines for hledger or
|
||||
its most useful subcommands by adding the `--tldr` flag (or just
|
||||
`--tl`). For best appearance you should install the [`tldr`][tldr] client,
|
||||
though it's not required.
|
||||
|
||||
These short "tldr pages" are a great counterbalance to verbose PTA docs.
|
||||
You can also use `tldr` without hledger to view the latest versions, or translations:\
|
||||
`tldr hledger[-COMMAND]`.
|
||||
Or you can [browse tldr pages online](https://tldr.inbrowser.app/search?query=hledger+).
|
||||
Consider contributing translations!
|
||||
More tips at <https://github.com/simonmichael/hledger/tree/master/doc/tldr>.
|
||||
|
||||
[tldr]: https://tldr.sh
|
||||
|
||||
Improvements
|
||||
|
||||
- The `hledger` commands list has been reorganised,
|
||||
with commands listed roughly in the order you'll need them.
|
||||
|
||||
- The general flags descriptions in `--help` have been updated and grouped.
|
||||
|
||||
- Correctness checks now run in a documented order. `commodities` are
|
||||
now checked before `accounts`, and `tags` before `recentassertions`.
|
||||
When both `ordereddates` and `assertions` checks are enabled,
|
||||
`ordereddates` now runs first, giving more useful error messages.
|
||||
|
||||
- `-I`/`--ignore-assertions` is now overridden by `-s`/`--strict`
|
||||
(or `check assertions`), enabling more flexible workflows.
|
||||
Eg you can `alias hl="hledger -I"` to delay balance assertions
|
||||
checking until you add `-s` to commands.
|
||||
|
||||
- `--color` and `--pretty` now also accept `y` or `n` as argument.
|
||||
|
||||
- When built with the `ghcdebug` flag and started with `--debug=-1`,
|
||||
hledger can be controlled by [ghc-debug] clients like
|
||||
ghc-debug-brick or a ghc-debug query script, for analysing
|
||||
memory/profile info.
|
||||
|
||||
[ghc-debug]: https://gitlab.haskell.org/ghc/ghc-debug
|
||||
|
||||
Fixes
|
||||
|
||||
- `hledger COMMAND --man` and `hledger help TOPIC --man` now properly scroll
|
||||
the man page to the TOPIC or COMMAND heading.
|
||||
The exact/prefix matching behaviour has been clarified in `help --help`.
|
||||
|
||||
- In journal files, `include` directives with trailing whitespace are now parsed correctly.
|
||||
|
||||
- The help command's help flags are now consistent with other commands
|
||||
(and it has `--debug` as a hidden flag).
|
||||
|
||||
- Build errors with GHC 8.10 have been fixed. [#2198]
|
||||
|
||||
Docs
|
||||
|
||||
- The tables of contents on hledger.org pages now just list top-level headings,
|
||||
(and the hledger manual structure has been adjusted for this).
|
||||
This makes the hledger manual on hledger.org more scannable and less scary.
|
||||
- add: drop lengthy transcript, add simpler example commands (from tldr)
|
||||
- Amount formatting: move down, it's not the best first topic
|
||||
- balance: mention the `--summary-only` flag
|
||||
- check: expand check descriptions
|
||||
- examples: CSV rules: vanguard, fidelity, paypal updates
|
||||
- Generating data: rewrite
|
||||
- manuals: synopsis, options cleanup/consistency
|
||||
- Options: correction, NO_COLOR does not override --color
|
||||
- PART 4: COMMANDS: reorganise into groups, like the CLI commands list.
|
||||
- Period expressions: mention last day of month adjusting [#2005]
|
||||
- Secondary dates: expand, and declare them deprecated.
|
||||
- Time periods cleanup, simplify markup
|
||||
- Unicode characters: mention UTF-8 on windows
|
||||
- web, json output: link to OpenAPI spec
|
||||
|
||||
Scripts/addons
|
||||
|
||||
- Added `hledger-pricehist`, an alias for the `pricehist` market price
|
||||
fetcher so that it can appear in hledger's commands list.
|
||||
|
||||
[#2005]: https://github.com/simonmichael/hledger/issues/2005
|
||||
[#2198]: https://github.com/simonmichael/hledger/issues/2198
|
||||
|
||||
|
||||
### hledger-ui 1.34
|
||||
|
||||
|
||||
Features
|
||||
|
||||
- You can now get a quick list of example command lines by running with `--tldr` (or just `--tl`).
|
||||
For best appearance, install the [`tldr`][tldr] client, though it's not required.
|
||||
|
||||
Improvements
|
||||
|
||||
- The general flags in `--help` have been updated and grouped,
|
||||
consistent with hledger.
|
||||
|
||||
- When built with the `ghcdebug` flag and started with `--debug=-1`,
|
||||
hledger-ui can be controlled by [ghc-debug] clients like
|
||||
ghc-debug-brick or a ghc-debug query script, for analysing
|
||||
memory/profile info.
|
||||
|
||||
[tldr]: https://tldr.sh
|
||||
[ghc-debug]: https://gitlab.haskell.org/ghc/ghc-debug
|
||||
|
||||
|
||||
### hledger-web 1.34
|
||||
|
||||
|
||||
Features
|
||||
|
||||
- You can now get a quick list of example command lines by running with `--tldr` (or just `--tl`).
|
||||
For best appearance, install the [`tldr`][tldr] client, though it's not required.
|
||||
|
||||
Improvements
|
||||
|
||||
- The general flags in `--help` have been updated and grouped,
|
||||
consistent with hledger.
|
||||
|
||||
- When built with the `ghcdebug` flag and started with `--debug=-1`,
|
||||
hledger-web can be controlled by [ghc-debug] clients like
|
||||
ghc-debug-brick or a ghc-debug query script, for analysing
|
||||
memory/profile info.
|
||||
|
||||
Docs
|
||||
|
||||
- A basic [OpenAPI specification][openapi.yaml] is provided for hledger-web's JSON-over-HTTP API.
|
||||
This is also applicable to `hledger print`'s JSON output format.
|
||||
|
||||
[ghc-debug]: https://gitlab.haskell.org/ghc/ghc-debug
|
||||
[openapi.yaml]: https://github.com/simonmichael/hledger/blob/master/hledger-web/config/openapi.yaml
|
||||
[tldr]: https://tldr.sh
|
||||
|
||||
|
||||
### project changes 1.34
|
||||
|
||||
|
||||
Docs
|
||||
|
||||
- move release notes from the hledger_site repo to the main hledger repo
|
||||
- github release notes: show the release notes, hide the install instructions by default
|
||||
- github release notes: improve windows install commands
|
||||
- github release notes: start mentioning github usernames, enabling the Contributors avatar list
|
||||
- dev docs: new Developer FAQ, Contributor Quick Start updates
|
||||
|
||||
Scripts/addons
|
||||
|
||||
- `hledger-install.sh` now uses stackage nightly, and a failure on non-Windows platforms has been fixed.
|
||||
|
||||
Infrastructure/misc
|
||||
|
||||
- A new `release` workflow creates github releases, uploads release binaries and generates release notes.
|
||||
- There is a new `oldest` workflow for testing the oldest GHC we support (currently 8.10.7).
|
||||
- The `binaries-mac-x64` workflow has been bumped from GHC 9.4 to 9.8.
|
||||
- The master branch's `ci` workflow has been updated to Ubuntu 24.04
|
||||
and uses the preinstalled GHC & stack, saving some work.
|
||||
- `md-issue-refs` helps generate markdown issue links.
|
||||
- `relnotes.hs` helps generate release notes from changelogs.
|
||||
- The project `Makefile` has now been fully replaced by `Justfile`.
|
||||
|
||||
|
||||
### credits 1.34
|
||||
|
||||
|
||||
Simon Michael (@simonmichael)
|
||||
|
||||
|
||||
|
||||
## 2024-05-02 hledger-1.33.1
|
||||
|
||||
### hledger 1.33.1
|
||||
|
||||
@ -21,17 +21,16 @@ Improvements
|
||||
Internal/api/developer-ish changes in the hledger-lib (and hledger) packages.
|
||||
For user-visible changes, see the hledger package changelog.
|
||||
|
||||
|
||||
# b7e5c05da
|
||||
|
||||
Breaking changes
|
||||
|
||||
Fixes
|
||||
# 1.34 2024-06-01
|
||||
|
||||
Improvements
|
||||
|
||||
- InputOpts has a new `_defer` flag for internal use instead of overusing `strict_`
|
||||
|
||||
- moved journalCheckBalanceAssertions to JournalChecks
|
||||
- journalCheckBalanceAssertions has moved to JournalChecks
|
||||
|
||||
|
||||
# 1.33.1 2024-05-02
|
||||
|
||||
@ -21,24 +21,26 @@ API
|
||||
User-visible changes in hledger-ui.
|
||||
See also the hledger changelog.
|
||||
|
||||
# 2a659e18d
|
||||
|
||||
Breaking changes
|
||||
|
||||
Fixes
|
||||
# 1.34 2024-06-01
|
||||
|
||||
Features
|
||||
|
||||
- You can now get a quick list of example command lines by running with `--tldr` (or just `--tl`).
|
||||
For best appearance, install the [`tldr`][tldr] client, though it's not required.
|
||||
|
||||
Improvements
|
||||
|
||||
- When built with the ghcdebug flag and started with --debug=-1,
|
||||
hledger-ui can be controlled by ghc-debug clients like
|
||||
- The general flags in `--help` have been updated and grouped,
|
||||
consistent with hledger.
|
||||
|
||||
- When built with the `ghcdebug` flag and started with `--debug=-1`,
|
||||
hledger-ui can be controlled by [ghc-debug] clients like
|
||||
ghc-debug-brick or a ghc-debug query script, for analysing
|
||||
memory/profile info.
|
||||
|
||||
Docs
|
||||
|
||||
API
|
||||
[tldr]: https://tldr.sh
|
||||
[ghc-debug]: https://gitlab.haskell.org/ghc/ghc-debug
|
||||
|
||||
|
||||
# 1.33.1 2024-05-02
|
||||
|
||||
@ -21,27 +21,32 @@ API
|
||||
User-visible changes in hledger-web.
|
||||
See also the hledger changelog.
|
||||
|
||||
# a7026d694
|
||||
|
||||
Breaking changes
|
||||
|
||||
Fixes
|
||||
# 1.34 2024-06-01
|
||||
|
||||
Features
|
||||
|
||||
- You can now get a quick list of example command lines by running with `--tldr` (or just `--tl`).
|
||||
For best appearance, install the [`tldr`][tldr] client, though it's not required.
|
||||
|
||||
Improvements
|
||||
|
||||
- When built with the ghcdebug flag and started with --debug=-1,
|
||||
hledger-web can be controlled by ghc-debug clients like
|
||||
- The general flags in `--help` have been updated and grouped,
|
||||
consistent with hledger.
|
||||
|
||||
- When built with the `ghcdebug` flag and started with `--debug=-1`,
|
||||
hledger-web can be controlled by [ghc-debug] clients like
|
||||
ghc-debug-brick or a ghc-debug query script, for analysing
|
||||
memory/profile info.
|
||||
|
||||
Docs
|
||||
|
||||
- A basic OpenAPI specification is provided for hledger-web's JSON-over-HTTP API.
|
||||
(This is also applicable to `hledger print`'s JSON output format.)
|
||||
- A basic [OpenAPI specification][openapi.yaml] is provided for hledger-web's JSON-over-HTTP API.
|
||||
This is also applicable to `hledger print`'s JSON output format.
|
||||
|
||||
API
|
||||
[ghc-debug]: https://gitlab.haskell.org/ghc/ghc-debug
|
||||
[openapi.yaml]: https://github.com/simonmichael/hledger/blob/master/hledger-web/config/openapi.yaml
|
||||
[tldr]: https://tldr.sh
|
||||
|
||||
|
||||
# 1.33.1 2024-05-02
|
||||
|
||||
@ -23,22 +23,37 @@ API
|
||||
User-visible changes in the hledger command line tool and library.
|
||||
|
||||
|
||||
# b7e5c05da
|
||||
# 1.34 2024-06-01
|
||||
|
||||
Breaking changes
|
||||
|
||||
- `check ordereddates` no longer supports `--date2`; it checks primary
|
||||
dates only.
|
||||
|
||||
Fixes
|
||||
|
||||
- `include` directives with trailing whitespace are now parsed correctly.
|
||||
- `check ordereddates` no longer supports `--date2`.
|
||||
Also (not a breaking change): `--date2` and secondary dates are now officially
|
||||
[deprecated](https://hledger.org/1.34/hledger.html#secondary-dates) in hledger,
|
||||
though kept for compatibility.
|
||||
|
||||
Features
|
||||
|
||||
- You can now get a quick list of example command lines for hledger or
|
||||
its most useful subcommands by adding the `--tldr` flag (or just
|
||||
`--tl`). For best appearance you should install the [`tldr`][tldr] client,
|
||||
though it's not required.
|
||||
|
||||
These short "tldr pages" are a great counterbalance to verbose PTA docs.
|
||||
You can also use `tldr` without hledger to view the latest versions, or translations:\
|
||||
`tldr hledger[-COMMAND]`.
|
||||
Or you can [browse tldr pages online](https://tldr.inbrowser.app/search?query=hledger+).
|
||||
Consider contributing translations!
|
||||
More tips at <https://github.com/simonmichael/hledger/tree/master/doc/tldr>.
|
||||
|
||||
[tldr]: https://tldr.sh
|
||||
|
||||
Improvements
|
||||
|
||||
- The CLI commands list has been reorganised.
|
||||
- The `hledger` commands list has been reorganised,
|
||||
with commands listed roughly in the order you'll need them.
|
||||
|
||||
- The general flags descriptions in `--help` have been updated and grouped.
|
||||
|
||||
- Correctness checks now run in a documented order. `commodities` are
|
||||
now checked before `accounts`, and `tags` before `recentassertions`.
|
||||
@ -50,21 +65,55 @@ Improvements
|
||||
Eg you can `alias hl="hledger -I"` to delay balance assertions
|
||||
checking until you add `-s` to commands.
|
||||
|
||||
- `--color` and `--pretty` now also accept `y` or `n` as argument.
|
||||
|
||||
- When built with the `ghcdebug` flag and started with `--debug=-1`,
|
||||
hledger can be controlled by ghc-debug clients like
|
||||
hledger can be controlled by [ghc-debug] clients like
|
||||
ghc-debug-brick or a ghc-debug query script, for analysing
|
||||
memory and profiling info.
|
||||
memory/profile info.
|
||||
|
||||
[ghc-debug]: https://gitlab.haskell.org/ghc/ghc-debug
|
||||
|
||||
Fixes
|
||||
|
||||
- `hledger COMMAND --man` and `hledger help TOPIC --man` now properly scroll
|
||||
the man page to the TOPIC or COMMAND heading.
|
||||
The exact/prefix matching behaviour has been clarified in `help --help`.
|
||||
|
||||
- In journal files, `include` directives with trailing whitespace are now parsed correctly.
|
||||
|
||||
- The help command's help flags are now consistent with other commands
|
||||
(and it has `--debug` as a hidden flag).
|
||||
|
||||
- Build errors with GHC 8.10 have been fixed. [#2198]
|
||||
|
||||
Docs
|
||||
|
||||
- The tables of contents on hledger.org pages now just list top-level headings,
|
||||
(and the hledger manual structure has been adjusted for this).
|
||||
This makes the hledger manual on hledger.org more scannable and less scary.
|
||||
- add: drop lengthy transcript, add simpler example commands (from tldr)
|
||||
- Amount formatting: move down, it's not the best first topic
|
||||
- balance: mention the `--summary-only` flag
|
||||
- check: expand check descriptions
|
||||
- examples: CSV rules: vanguard, fidelity, paypal updates
|
||||
- Generating data: rewrite
|
||||
- JSON output: link to OpenAPI spec
|
||||
- manuals: synopsis, options cleanup/consistency
|
||||
- Options: correction, NO_COLOR does not override --color
|
||||
- PART 4: COMMANDS: reorganise into groups, like the CLI commands list.
|
||||
- Period expressions: mention last day of month adjusting [#2005]
|
||||
- Secondary dates: expand, and declare them deprecated.
|
||||
- Time periods cleanup, simplify markup
|
||||
- Unicode characters: mention UTF-8 on windows
|
||||
|
||||
Scripts/addons
|
||||
|
||||
- Added `hledger-pricehist`, an alias for the `pricehist` market price
|
||||
fetcher so that it can appear in hledger's commands list.
|
||||
|
||||
API
|
||||
[#2005]: https://github.com/simonmichael/hledger/issues/2005
|
||||
[#2198]: https://github.com/simonmichael/hledger/issues/2198
|
||||
|
||||
|
||||
# 1.33.1 2024-05-02
|
||||
|
||||
Loading…
Reference in New Issue
Block a user