Skip to content

Commit

Permalink
;doc: edit changelogs
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed Jan 14, 2021
1 parent ce457be commit 4e3dc13
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 101 deletions.
50 changes: 4 additions & 46 deletions CHANGES.md
Expand Up @@ -2,53 +2,11 @@ General project-related changes and major/notable all-package releases.
For package-specific changes and minor releases, see the package changelogs.

# 1.20.3 2021-01-14
- bin: switch to "runghc", drop "env -S" (#1453)
env -S isn't a thing on linux of course. Go back to using standard
env, which means using a stack options line, which means not using
"ghc". This new setup is probably simpler anyway. I've just had to
give up on the goal of having each script's required packages being
defined in one place; now (to they extent they are required) they
must be defined both in the script header and in compile.sh.

(cherry picked from commit 32ccbba8050a26d09eb0fa8fdbc2c4b7ffe4f44c)

- bin: switch scripts to "stack ghc" and "env -S" (#1453)
Using stack's script command meant that the scripts needed to be
compatible, and regularly tested, with a hledger release in stackage,
rather than the latest hledger source. This created hassles for
maintainers, contributors and sometimes for users.

To simplify things overall, we now require script users to check out
the hledger source tree and run the scripts (or, bin/compile.sh) from
there once so they compile themselves. Some notes on alternative
setups are included (in one of the scripts, and referenced by the
others). This ensures that users and our CI tests are building scripts
the same way.

Current stack does not allow a stack options line to be used with the
"stack ghc" command, unfortunately, so instead we are using env's -S
flag, which hopefully has sufficiently wide support by now, and
putting all arguments in the shebang line.

This method will probably require complete explicit --package options,
unlike "stack script", so more testing and tweaking is expected.
Probably we're going to end up with some long shebang lines.

This isn't pretty but seems like a possible way to keep things
manageable.

(cherry picked from commit 2db87333d702d27ee45d8089ad4ad189bcb50cf2)

- ci: really add addon-building tests to CI (#1453)
(cherry picked from commit 3ae6cf3200fad46cfbfa15c89e6d06dac309d76c)

- ci: also test compilation of bin/ add-on scripts
(cherry picked from commit 06b466d847c46dc384cdef95658dade68111b173)

- bin: Update bin scripts for current hledger-lib. (Stephen Morgan)
(cherry picked from commit bc4aef17b7fa13ec0754b93325e1c5e5ee04f1e7)
(cherry picked from commit a64d1aa6d0bcaf643bbe2607238026b4d26a3637)

- The run/compile instructions for add-on scripts in bin/ have been
updated. The scripts now use `stack runghc` and are tested (manually
with `make functest` for now) with the corresponding hledger source,
not the hledger on stackage.

# 1.20 2020-12-05
- examples: clean up & add more budgeting examples
Expand Down
47 changes: 2 additions & 45 deletions hledger-lib/CHANGES.md
Expand Up @@ -2,54 +2,11 @@ Internal/api/developer-ish changes in the hledger-lib (and hledger) packages.
For user-visible changes, see the hledger package changelog.

# 1.20.3 2021-01-14
- journal: allow commodity directive to set style of no-symbol commodity (#1461)
(cherry picked from commit c5571f6468ab11ffe3cd3f86a86f0b3253be10d1)
(cherry picked from commit 034c317496e99271ebabc53af112ad88e054b7ab)

- lib: Calculate value at posting date for register --value=then -M. (Stephen Morgan)

- bin: Update bin scripts for current hledger-lib. (Stephen Morgan)
(cherry picked from commit bc4aef17b7fa13ec0754b93325e1c5e5ee04f1e7)
(cherry picked from commit a64d1aa6d0bcaf643bbe2607238026b4d26a3637)

- lib,cli: Revert --value=end PeriodChange behaviour to hledger-1.19, i.e. calculating the value of the change, rather than the change of the value. (Stephen Morgan)

- new price search that really finds the shortest path (#1443)
This one should also reliably prevent runaway searches in the event of more bugs, giving up after 1000 iterations.

(cherry picked from commit 3d7d5c0db7509299acf3d33530728f834345959a)

- lib: valuation: simplify price search code
This version tries counting recursions instead of path length, but I
think they are the same.

(cherry picked from commit 7c9303a15c64859f11aec8fa75546793827e3086)

- lib: valuation: don't hang when finding prices (fixes #1439)
Searching for prices during valuation no longer now properly excludes
price loops, avoiding near infinite looping with certain
configurations of market prices. Also we now always use a direct price
when available, rather than searching unnecessarily.

Price searching progress info, useful for troubleshooting, is now
displayed with --debug=2.

There could still be some corner cases we don't handle correctly. We
now give up with an error message if the searched price chains get too
long (> 1000). More importantly, we should also give up if the search
iterates too many times, but this is not done yet.

(cherry picked from commit 73678393b1ec9ea414d798ade9da6e5666c079c2)

- journal: Ignore AUTO commodity when strict checking (aragaer)
AUTO commodity is a placeholder for postings with missing amounts. It
should be ignored when doing a strict commodity check.

Fixes #1419

(cherry picked from commit 2084b845e09d2249a5d0e120805798730eeb4b6d)
- See hledger.

# 1.20.2 2020-12-28

- Fix the info manuals' node structure.

- Drop unused parsec dependency.
Expand Down
4 changes: 4 additions & 0 deletions hledger-ui/CHANGES.md
Expand Up @@ -2,7 +2,11 @@ User-visible changes in hledger-ui.
See also the hledger changelog.

# 1.20.3 2021-01-14

- Use hledger 1.20.3.

# 1.20.2 2020-12-28

- Fix loss of capitalisation in part of the manual.

- Fix the info manual's node structure.
Expand Down
4 changes: 4 additions & 0 deletions hledger-web/CHANGES.md
Expand Up @@ -2,7 +2,11 @@ User-visible changes in hledger-web.
See also the hledger changelog.

# 1.20.3 2021-01-14

- Use hledger 1.20.3.

# 1.20.2 2020-12-28

- Fix the info manual's node structure.

- Use hledger 1.20.2.
Expand Down
37 changes: 27 additions & 10 deletions hledger/CHANGES.md
Expand Up @@ -2,24 +2,41 @@ User-visible changes in the hledger command line tool and library.


# 1.20.3 2021-01-14
- lib: Calculate value at posting date for register --value=then -M. (Stephen Morgan)

- lib: better message when roi fails to value commodity, fixes #1446 (Dmitry Astapov)
(cherry picked from commit 9869624c5c42751dac5b431827b2fb368da43070)
- When searching for price chains during valuation/currency conversion:

- cli,csv: Fix --drop option in csv output format (aragaer)
(cherry picked from commit 7bde3345b89422c21ffee6f61712c8c225bc9577)
- It no longer hangs when there are price loops. (And in case of
future bugs, it will give up rather than search forever.) (#1439)
- It now really finds the shortest path. (#1443)
- Useful progress info is displayed with `--debug=1` or `--debug=2`.

- lib,cli: Revert --value=end PeriodChange behaviour to hledger-1.19, i.e. calculating the value of the change, rather than the change of the value. (Stephen Morgan)
- balance, incomestatement: End-valued multi-period balance change
reports (eg: `bal -MV`) have been reverted to show value-of-change,
as in previous hledger versions, rather than change-of-value, for
now. (#1353, #1428) (Stephen Morgan)

- test: Update for tests failing now that it's 2021. (Stephen Morgan)
- balance: End-valued balance change reports now choose the same final
valuation date and show consistent results whether single-period or
multi-period. (#1424) (Stephen Morgan)

- new price search that really finds the shortest path (#1443)
This one should also reliably prevent runaway searches in the event of more bugs, giving up after 1000 iterations.
- balance: the `--drop` option now works with `csv` and `html` output.
(#1456) (Ilya Konovalov)

(cherry picked from commit 3d7d5c0db7509299acf3d33530728f834345959a)
- check: the `commodities` check, and `-s`/`--strict` mode, now ignore
the "AUTO" internal pseudo-commodity. (#1419) (Ilya Konovalov)

- register: Then-valued multi-period register reports
(eg: `register -M --value=then`) now calculate the correct values.
(#1449) (Stephen Morgan)

- roi: now shows a better error message when required prices are
missing. (#1446) (Dmitry Astapov)

- The no-symbol commodity's input number format can now be set by a
`commodity` directive, like other commodities. (#1461)

# 1.20.2 2020-12-28

- help: Fix loss of capitalisation in part of the hledger-ui manual.

- Fix the info manuals' node structure.
Expand Down

0 comments on commit 4e3dc13

Please sign in to comment.