Merge pull request #126 into master

a16dd15 CHANGELOG: add v1.0.0-beta.3 (Aaron Fiore)
This commit is contained in:
2024-08-20 16:39:21 -07:00

View File

@@ -18,6 +18,133 @@
# Changelog (`docker-finance`)
## 1.0.0-beta.3 - 2024-08-20
⚠️ **Breaking changes for this pre-release** ⚠️
#### Repo
❗ For installation:
- 🚨 **MUST** re-run the installation procedure in [README.md](README.md#installation)
#### Client
❗ For client-side environment:
- 🚨 **MUST** re-run `gen` command
* Regenerate client env and Dockerfile (select 'Y' to all):
```
├─ Client-side environment found, backup then generate new one? [Y/n]
│ └─ Edit (new) environment now? [Y/n]
├─ Custom (optional) Dockerfile found, backup then generate new one? [Y/n]
│ └─ Edit (new) custom Dockerfile now? [Y/n]
```
* Regenerate client/container (select 'Y' to all):
- Superscript:
```
│ ├─ Generate (or update) joint client/container shell script (superscript)? [Y/n]
│ │ └─ Edit (new) superscript now? [Y/n]
```
- Subprofile shell script:
```
│ ├─ Generate (or update) container flow configs and/or accounts? [Y/n]
│ │ │
│ │ ├─ Generate (or update) subprofile's shell script? [Y/n]
```
* Take note of the updated default environment
- Default directory 'hledger-flow' is now 'finance-flow'
- Your client-side 'hledger-flow' directory can also be renamed
- 🚨 **MUST** re-run `build` command
1. Remove (`rm`) previous images
2. Clean build cache (`docker system prune`)
3. Re-run a fresh `build` of your docker-finance
> Tip: when in doubt, regenerate your entire setup. Your environment and accounts will be backed up in the process.
#### Container
Aside from changes above, there are no breaking changes for container.
❗ For accounts:
- 🚨 **SHOULD** re-run `import` command
* Applicable only to Capital One (bank) account ([#124](https://gitea.com/EvergreenCrypto/docker-finance/pulls/124))
---
### 🧠 Contributors
- Aaron Fiore
### 🛠️ Fixes / Updates
#### Repo
- CHANGELOG.md ([#126](https://gitea.com/EvergreenCrypto/docker-finance/pulls/126))
* Add v1.0.0-beta.3
- README.md ([`cab7551`](https://gitea.com/EvergreenCrypto/docker-finance/commit/cab7551cbb343e1b46eaba7e76c6321e1061baf0)) ([`d86da4b`](https://gitea.com/EvergreenCrypto/docker-finance/commit/d86da4b4d5e3734a9685a29e9e94893b457d5b1a)) ([`3bfa39d`](https://gitea.com/EvergreenCrypto/docker-finance/commit/3bfa39de87eebc6c7fa9dca7d80a0f5095eba0ca)) ([#119](https://gitea.com/EvergreenCrypto/docker-finance/pulls/119))
* Update to reflect latest impl
#### Client
- Bump manifest version to v1.0.0-beta.3 ([#127](https://gitea.com/EvergreenCrypto/docker-finance/pulls/127))
- Change environment defaults for `DOCKER_FINANCE_*_FLOW` ([#114](https://gitea.com/EvergreenCrypto/docker-finance/pulls/114))
- Dockerfiles updates ([#121](https://gitea.com/EvergreenCrypto/docker-finance/pulls/121)) ([#123](https://gitea.com/EvergreenCrypto/docker-finance/pulls/123))
* Add package `yq` (kislyuk's), remove `shyaml`
* Remove `pipx` from Dockerfiles, replace with packaged `csvkit`
* Comment all optional userspace packages
- `lib_gen` ([#108](https://gitea.com/EvergreenCrypto/docker-finance/pulls/108))
* Refactor flow generation
* Fix missing copy of default custom Dockerfile
- Miscellaneous fixes ([#106](https://gitea.com/EvergreenCrypto/docker-finance/pulls/106)) ([#107](https://gitea.com/EvergreenCrypto/docker-finance/pulls/107)) ([#115](https://gitea.com/EvergreenCrypto/docker-finance/pulls/115)) ([#117](https://gitea.com/EvergreenCrypto/docker-finance/pulls/117))
* Fix usage typo
* Remove share.d from $PATH
* Clarify `hledger` (not `ledger`), update usage help / completion
* Disable shellcheck warning for `DOCKER_FINANCE_DEBUG`
- New installation method ([#104](https://gitea.com/EvergreenCrypto/docker-finance/pulls/104)) ([#105](https://gitea.com/EvergreenCrypto/docker-finance/pulls/105))
* Add `install.bash`
* Add `dfi` alias to [Mostly-Unified CLI](README.md#mostly-unified-cli)
- Update Doxygen ([#113](https://gitea.com/EvergreenCrypto/docker-finance/pulls/113))
* Bump to 1.9.8
- Change 'modules' to 'topics'
#### Container
- Capital One (bank) ([#124](https://gitea.com/EvergreenCrypto/docker-finance/pulls/124))
* Add interest income
- `fetch` fixes ([#102](https://gitea.com/EvergreenCrypto/docker-finance/pulls/102))
- Throw errors with nested status
- Catch unrecoverable CoinGecko error
* Fix for when 'all' years are requested without paid-plan API key
### ☀️ Features / Enhancements
#### Client / Container
- Add bash completion ([#103](https://gitea.com/EvergreenCrypto/docker-finance/pulls/103)) ([#112](https://gitea.com/EvergreenCrypto/docker-finance/pulls/112))
- Add plugins support ([#109](https://gitea.com/EvergreenCrypto/docker-finance/pulls/109)) ([#111](https://gitea.com/EvergreenCrypto/docker-finance/pulls/111)) ([#118](https://gitea.com/EvergreenCrypto/docker-finance/pulls/118)) ([#120](https://gitea.com/EvergreenCrypto/docker-finance/pulls/120)) ([#122](https://gitea.com/EvergreenCrypto/docker-finance/pulls/122))
* Add `plugins` command
* Add documentation, examples
* Add proxychains-ng / [Tor](https://www.torproject.org/) plugin
* Add [`timewarrior`](https://timewarrior.net/) to hledger timeclock plugin
- Add `times` command (timewarrior) ([#110](https://gitea.com/EvergreenCrypto/docker-finance/pulls/110))
### 🌴 Misc / Other
#### Client
- `lib_docker` ([#125](https://gitea.com/EvergreenCrypto/docker-finance/pulls/125))
* Add tag to container name
* Remove platform from network name
#### Client / Container
- Refactor to use `yq` (kislyuk's), remove `shyaml` ([#121](https://gitea.com/EvergreenCrypto/docker-finance/pulls/121))
- Set xtrace if debug is enabled ([#116](https://gitea.com/EvergreenCrypto/docker-finance/pulls/116))
## 1.0.0-beta.2 - 2024-07-30
⚠️ **Breaking changes for this pre-release** ⚠️