doc: changelogs, release notes

This commit is contained in:
Simon Michael 2016-12-31 11:24:12 -08:00
parent 6072f2a8f4
commit 20bef095aa
7 changed files with 241 additions and 101 deletions

View File

@ -1,109 +1,10 @@
Project-wide changes in the hledger project.
See also the package change logs.
# 1.1 (unreleased)
(Changes in all packages - move to package changelogs before release:)
## misc
- fix non-existent "oldtime" dependency in hledger package (#431)
- update base lower bound to enforce GHC 7.10+
hledger-lib had a valid install plan with GHC 7.8, but currently requires GHC 7.10 to compile.
Now we require base 4.8+ everywhere to ensure the right GHC version at the start.
- Hledger.Read api cleanups
- rename dbgIO to dbg0IO, consistent with dbg0, and document a bug in dbg*IO
- make readJournalFiles [f] equivalent to readJournalFile f (#437)
- more general parser types enabling reuse outside of IO (#439)
## cli
- more predictable file format detection
When we don't recognise a file's extension, instead of choosing a subset of
readers to try based on content sniffing, now we just try them all.
Also, this can be overridden by prepending the reader name and a
colon to the file path (eg timedot:file.dat, csv:-).
- don't show stack trace details in errors with GHC 8+
## ui
- mark hledger-ui as "stable"
- allow brick 0.15, vty 5.14, text-zipper 0.9
- with --watch, the display updates automatically to show file or date changes
hledger-ui --watch will reload data when the journal file (or any included file) changes.
Also, when viewing a current standard period (ie this day/week/month/quarter/year),
the period will move as needed to track the current system date.
- the --change flag shows period changes at startup instead of historical ending balances
- the A key runs the hledger-iadd tool, if installed
- always reload when g is pressed
Previously it would check the modification time and reload only if
it looked newer than the last reload.
## web
- add --host option (#429)
This came up in the context of Docker, but it seems it wasn't
possible for hledger-web to serve remote clients directly (without
a proxy) because of 127.0.0.1 being hardcoded. That can now be
changed with --host=IPADDR. Also, the default base url uses this
address rather than a hard-coded "localhost".
- rename --server to --serve
The --server flag sounded too close in meaning to --host so
I've renamed it to --serve. The old spelling is still accepted,
but deprecated and will be removed in the next release.
## api
- serves on 127.0.0.1 by default, --host option added (#432)
Consistent with hledger-web: serves only local requests by default,
use --host=IPADDR to change this.
- fixed the version string in command-line help and swagger info
## csv format
- create default rules file only if CSV reader succeeds
## journal format
- balance assignments are now supported (#438, #129, #157, #288)
This feature also brings a slight performance drop (~5%);
optimisations welcome.
- also recognise `*.hledger` files as hledger journal format
## ledger format
- use ledger-parse from the ledger4 project as an alternate reader for C++ Ledger journals
The idea is that some day we might get better compatibility with Ledger files this way.
Right now this reader is not very useful and will be used only if you explicitly select it with a `ledger:` prefix.
It parses transaction dates, descriptions, accounts and amounts, and ignores everything else.
Amount parsing is delegated to hledger's journal parser, and malformed amounts might be silently ignored.
This adds at least some of the following as new dependencies for hledger-lib:
parsers, parsec, attoparsec, trifecta.
# 1.1 (2016/12/31)
...see release-notes.md...
# 1.0.1 (2016/10/27)

View File

@ -2,6 +2,16 @@ User-visible changes in hledger-api.
See also the hledger and the project change logs.
# 1.1 (2016/12/31)
- serves on 127.0.0.1 by default, --host option added (#432)
Consistent with hledger-web: serves only local requests by default,
use --host=IPADDR to change this.
- fixed the version string in command-line help and swagger info
# 1.0 (2016/10/26)
## misc

View File

@ -2,6 +2,45 @@ API-ish changes in the hledger-lib package.
See also the hledger and project change logs (for user-visible changes).
# 1.1 (2016/12/31)
## journal format
- balance assignments are now supported (#438, #129, #157, #288)
This feature also brings a slight performance drop (~5%);
optimisations welcome.
- also recognise `*.hledger` files as hledger journal format
## ledger format
- use ledger-parse from the ledger4 project as an alternate reader for C++ Ledger journals
The idea is that some day we might get better compatibility with Ledger files this way.
Right now this reader is not very useful and will be used only if you explicitly select it with a `ledger:` prefix.
It parses transaction dates, descriptions, accounts and amounts, and ignores everything else.
Amount parsing is delegated to hledger's journal parser, and malformed amounts might be silently ignored.
This adds at least some of the following as new dependencies for hledger-lib:
parsers, parsec, attoparsec, trifecta.
## misc
- update base lower bound to enforce GHC 7.10+
hledger-lib had a valid install plan with GHC 7.8, but currently requires GHC 7.10 to compile.
Now we require base 4.8+ everywhere to ensure the right GHC version at the start.
- Hledger.Read api cleanups
- rename dbgIO to dbg0IO, consistent with dbg0, and document a bug in dbg*IO
- make readJournalFiles [f] equivalent to readJournalFile f (#437)
- more general parser types enabling reuse outside of IO (#439)
# 1.0.1 (2016/10/27)
- allow megaparsec 5.0 or 5.1

View File

@ -2,6 +2,28 @@ User-visible changes in hledger-ui.
See also the hledger and project change logs.
# 1.1 (2016/12/31)
- with --watch, the display updates automatically to show file or date changes
hledger-ui --watch will reload data when the journal file (or any included file) changes.
Also, when viewing a current standard period (ie this day/week/month/quarter/year),
the period will move as needed to track the current system date.
- the --change flag shows period changes at startup instead of historical ending balances
- the A key runs the hledger-iadd tool, if installed
- always reload when g is pressed
Previously it would check the modification time and reload only if
it looked newer than the last reload.
- mark hledger-ui as "stable"
- allow brick 0.15, vty 5.14, text-zipper 0.9
# 1.0.4 (2016/11/2)
- allow brick 0.13

View File

@ -2,6 +2,23 @@ User-visible changes in hledger-web.
See also the hledger and the project change logs.
# 1.1 (2016/12/31)
- add --host option (#429)
This came up in the context of Docker, but it seems it wasn't
possible for hledger-web to serve remote clients directly (without
a proxy) because of 127.0.0.1 being hardcoded. That can now be
changed with --host=IPADDR. Also, the default base url uses this
address rather than a hard-coded "localhost".
- rename --server to --serve
The --server flag sounded too close in meaning to --host so
I've renamed it to --serve. The old spelling is still accepted,
but deprecated and will be removed in the next release.
# 1.0.1 (2016/10/27)
- allow megaparsec 5.0 or 5.1

View File

@ -2,6 +2,21 @@ User-visible changes in the hledger and hledger-lib packages.
See also the project change log.
# 1.1 (2016/12/31)
## balance
- with -V, don't ignore market prices in the future (#453, #403)
- with -V and multiple same-date market prices, use the last parsed not the highest price (#403)
## misc
- fix non-existent "oldtime" dependency (#431)
- extra/hledger-equity.hs now generates valid journal format when there are multiple commodities
# 1.0.1 (2016/10/27)
- allow megaparsec 5.0 or 5.1

View File

@ -7,6 +7,7 @@ h4 { margin-top:2em; }
<nav id="toc">
<p>Major releases:</p>
<ol>
<li><a href="#hledger-1.1">hledger 1.1 (2016/12/31)</a>
<li><a href="#hledger-1.0">hledger 1.0 (2016/10/26)</a>
<li><a href="#hledger-0.27">hledger 0.27 (2015/10/30)</a>
<li><a href="#hledger-0.26">hledger 0.26 (2015/7/12)</a>
@ -52,6 +53,141 @@ change logs.
-->
## 2016/12/31 hledger 1.1
******
<!-- ([announcement](http://thread.gmane.org/gmane.comp.finance.ledger.hledger/1267)) -->
<!-- ([announcement](https://groups.google.com/d/topic/hledger/WgdTy3-a6sc/discussion)) -->
Release contributors:
Simon Michael, Johannes Gerer, Nikolay Orlyuk, Shubham Lagwankar. <!-- Justin Le -->
[project-wide](#project-wide-changes)
| [hledger-lib](#hledger-lib-1.1)
| [hledger](#hledger-1.1-1)
| [hledger-ui](#hledger-ui-1.1)
| [hledger-web](#hledger-web-1.1)
| [hledger-api](#hledger-api-1.1)
### project-wide changes
#### misc
- don't show stack trace details in errors
- more predictable file format detection
When we don't recognise a file's extension, instead of choosing a subset of
readers to try based on content sniffing, now we just try them all.
Also, this can be overridden by prepending the reader name and a
colon to the file path (eg timedot:file.dat, csv:-).
- avoid creating junk CSV rules files when trying alternate readers.
We now create it only after successfully reading a file as CSV.
- improvements to -B and -V docs: clearer descriptions, more linkage (#403)
### hledger-lib 1.1
#### journal format
- balance assignments are now supported (#438, #129, #157, #288)
This feature also brings a slight performance drop (~5%);
optimisations welcome.
- also recognise `*.hledger` files as hledger journal format
#### ledger format
- use ledger-parse from the ledger4 project as an alternate reader for C++ Ledger journals
The idea is that some day we might get better compatibility with Ledger files this way.
Right now this reader is not very useful and will be used only if you explicitly select it with a `ledger:` prefix.
It parses transaction dates, descriptions, accounts and amounts, and ignores everything else.
Amount parsing is delegated to hledger's journal parser, and malformed amounts might be silently ignored.
This adds at least some of the following as new dependencies for hledger-lib:
parsers, parsec, attoparsec, trifecta.
#### misc
- update base lower bound to enforce GHC 7.10+
hledger-lib had a valid install plan with GHC 7.8, but currently requires GHC 7.10 to compile.
Now we require base 4.8+ everywhere to ensure the right GHC version at the start.
- Hledger.Read api cleanups
- rename dbgIO to dbg0IO, consistent with dbg0, and document a bug in dbg*IO
- make readJournalFiles [f] equivalent to readJournalFile f (#437)
- more general parser types enabling reuse outside of IO (#439)
### hledger 1.1
#### balance
- with -V, don't ignore market prices in the future (#453, #403)
- with -V and multiple same-date market prices, use the last parsed not the highest price (#403)
#### misc
- fix non-existent "oldtime" dependency (#431)
- extra/hledger-equity.hs now generates valid journal format when there are multiple commodities
### hledger-ui 1.1
- with --watch, the display updates automatically to show file or date changes
hledger-ui --watch will reload data when the journal file (or any included file) changes.
Also, when viewing a current standard period (ie this day/week/month/quarter/year),
the period will move as needed to track the current system date.
- the --change flag shows period changes at startup instead of historical ending balances
- the A key runs the hledger-iadd tool, if installed
- always reload when g is pressed
Previously it would check the modification time and reload only if
it looked newer than the last reload.
- mark hledger-ui as "stable"
- allow brick 0.15, vty 5.14, text-zipper 0.9
### hledger-web 1.1
- add --host option (#429)
This came up in the context of Docker, but it seems it wasn't
possible for hledger-web to serve remote clients directly (without
a proxy) because of 127.0.0.1 being hardcoded. That can now be
changed with --host=IPADDR. Also, the default base url uses this
address rather than a hard-coded "localhost".
- rename --server to --serve
The --server flag sounded too close in meaning to --host so
I've renamed it to --serve. The old spelling is still accepted,
but deprecated and will be removed in the next release.
### hledger-api 1.1
- serves on 127.0.0.1 by default, --host option added (#432)
Consistent with hledger-web: serves only local requests by default,
use --host=IPADDR to change this.
- fixed the version string in command-line help and swagger info
## 2016/10/26 hledger 1.0
***More hledger-ui features,