hledger/doc/github-release.md

186 lines
6.1 KiB
Markdown
Raw Normal View History

2023-06-02 06:03:49 +03:00
<details>
<summary>
2024-01-28 15:26:35 +03:00
## Release notes (https://hledger.org/release-notes.html#2024-01-28-hledger-1323)
</summary>
2024-01-28 15:26:35 +03:00
### hledger 1.32.3
2024-01-28 15:26:35 +03:00
Fixes
2024-01-28 15:26:35 +03:00
- A performance slowdown since 1.29, especially noticeable with many
accounts and transactions, has been fixed. [#2153]
2023-12-02 08:22:06 +03:00
2024-01-28 15:26:35 +03:00
- Balance assertions involving mixed-cost balances are checked correctly again
(a regression in 1.30). [#2150]
2024-01-28 15:26:35 +03:00
- import --catchup works again (a regression in 1.32). [#2156]
2024-01-28 15:26:35 +03:00
- --anon is now a deprecated hidden flag that raises an error,
but is still usable as --obfuscate (also hidden). [#2133]
2024-01-28 15:26:35 +03:00
- Balance assertion error messages are clearer, and show the diff again.
2024-01-28 15:26:35 +03:00
### hledger-ui 1.32.3
2024-01-28 15:26:35 +03:00
- Use hledger-1.32.3
2024-01-28 15:26:35 +03:00
- Allow vty 6.2, brick 2.3
2023-12-02 08:22:06 +03:00
2024-01-28 15:26:35 +03:00
### hledger-web 1.32.3
- Use hledger-1.32.3
### project changes 1.32.3
- bin/hledger-bar: Fix an error when NO_COLOR is not defined;
allow color when NO_COLOR is defined but empty, per no-color spec;
and fix shellcheck warnings.
[#2159] (Colin Dean, Simon Michael)
- bin/hledger-simplebal: Fix shellcheck warnings. (Colin Dean)
### credits 1.32.3
Simon Michael,
Colin Dean.
[#2159]: https://github.com/simonmichael/hledger/issues/2159
[#2156]: https://github.com/simonmichael/hledger/issues/2156
[#2153]: https://github.com/simonmichael/hledger/issues/2153
[#2150]: https://github.com/simonmichael/hledger/issues/2150
[#2133]: https://github.com/simonmichael/hledger/issues/2133
</details>
## Install
At <https://hledger.org/install>, binary packages should be available for this release within a few days (look for green badges).
2024-01-28 15:26:35 +03:00
Or, you can build from source as described there, after cloning at tag `1.32.3`:
`git clone https://github.com/simonmichael/hledger --depth 1 -b 1.32.3`
Or, if under "Assets" below there are release binaries suitable for your OS and hardware, you can use those.
<!--
Note: release binaries have been updated:
- YYYY-MM-DD: description. [#NNNN](https://github.com/simonmichael/hledger/issues/NNNN)
-->
Here are platform-specific instructions for the release binaries.
(You can copy & paste each block of commands as a unit to save time.):
<details>
<summary>
### GNU/Linux on 64-bit Intel
</summary>
At the command line,
```
cd /usr/local/bin
2024-01-28 15:26:35 +03:00
curl -LOC- https://github.com/simonmichael/hledger/releases/download/1.32.3/hledger-linux-x64.zip # can rerun if interrupted
unzip hledger-linux-x64.zip; tar xvf hledger-linux-x64.tar; rm hledger-linux-x64.{zip,tar} # github workaround, preserves permissions
cd -
hledger --version # should show the new version
touch $HOME/.hledger.journal # ensure a default journal file exists
```
</details>
<details>
<summary>
### Mac on 64-bit Intel
</summary>
In a terminal window,
```
cd /usr/local/bin
2024-01-28 15:26:35 +03:00
curl -LOC- https://github.com/simonmichael/hledger/releases/download/1.32.3/hledger-mac-x64.zip
unzip hledger-mac-x64.zip; tar xvf hledger-mac-x64.tar; rm hledger-mac-x64.{zip,tar} # github workaround, preserves permissions
open .
# for the hledger, hledger-ui, hledger-web icons: right-click, Open, confirm it's ok to run
cd -
hledger --version # should show the new version
touch $HOME/.hledger.journal # ensure a default journal file exists
```
</details>
<details>
<summary>
### Windows 64-bit Intel (or ARM, using emulation)
</summary>
In a powershell window (press Windows-r, type powershell, press enter),
1. Make a place to keep hledger binaries, and add it to your PATH; this makes running hledger easier. You only need to do this once, not for every release:
```
mkdir -force $HOME\bin >$null
$ENV:PATH += ";"+$HOME+"\bin"
[Environment]::SetEnvironmentVariable("Path", [Environment]::GetEnvironmentVariable("Path", [EnvironmentVariableTarget]::User)+";"+$HOME+"\bin", [EnvironmentVariableTarget]::User)
```
2. Download and install the release binaries:
```
cd $HOME\bin
2024-01-28 15:26:35 +03:00
curl https://github.com/simonmichael/hledger/releases/download/1.32.3/hledger-windows-x64.zip -OutFile hledger-windows-x64.zip
Expand-Archive hledger-windows-x64.zip -DestinationPath .
rm hledger-windows-x64.zip
cd $HOME
hledger --version # should show the new version
```
3. Ensure a default journal file exists, and without a problematic encoding.
(Not sure why "ascii" is needed here - hledger likes utf8 and understands utf8 BOM headers..
but the state of [our unicode support on Windows](https://github.com/simonmichael/hledger/issues?q=is%3Aissue+label%3A%22platform%3A+windows%22+label%3Ai18n)
is really unknown, your input welcome.)
```
out-file -append -encoding ascii $HOME/.hledger.journal
```
Once that journal file exists, you can start hledger-web by double-clicking on the icon if you wish.
</details>
<details>
<summary>
### Windows 7 on 64-bit Intel
</summary>
- click hledger-windows-x64.zip below
- choose Open with Windows Explorer, OK
- click Extract all files
- choose a destination folder - ideally one that appears in `echo %PATH%`, like `C:\Windows` (though that one will require administrator permission); otherwise, your home directory (`C:\Users\YOURNAME`)
- check "Show extracted files when complete"
- click Extract, wait for the destination folder to open
- find the hledger, hledger-web icons (if you extracted to `\Windows`, you'll need to scroll down)
- for each icon: double-click, uncheck "Always ask before opening this file", click Run
- close those Explorer windows
- open a command window (press Windows-r, type CMD, press enter)
- `hledger --version` should show the new version
- `echo # >> .hledger.journal` to ensure a default journal file exists. (Important: the doubled **>>** is needed to avoid overwriting existing data.)
Problems:
- Starting hledger by double-clicking its icon won't work because it needs arguments; run it from the command window instead.
- Starting hledger-web by double-clicking its icon may fail eg because Explorer's command window is too small;
configure that to be larger, or run hledger-web from a command window instead.
- hledger or hledger-web may fail to run if there is not enough memory available.
</details>
## Next steps
2023-12-02 08:22:06 +03:00
- https://hledger.org/#quick-start
<!-- ## Updates -->
<!-- 2022-06-08: windows-x64 binaries fixed. [#1869](https://github.com/simonmichael/hledger/issues/1869) -->