mirror of
https://github.com/kvz/bash3boilerplate.git
synced 2024-12-18 22:27:51 +00:00
93 lines
4.2 KiB
Markdown
93 lines
4.2 KiB
Markdown
# Changelog
|
|
|
|
## master
|
|
|
|
Released: Unreleased. [Commit log](https://github.com/kvz/bash3boilerplate/compare/v2.2.0...master)
|
|
|
|
## v2.2.0
|
|
|
|
Released: 2016-12-21. [Commit log](https://github.com/kvz/bash3boilerplate/compare/v2.1.0...v2.2.0)
|
|
|
|
- Run shellcheck as part of the acceptance test (#79, @mstreuhofer)
|
|
- Brace all variables, used `[[` instead of `[` (#33, @mstreuhofer)
|
|
- Add automatic usage validation for required args (#22, @mstreuhofer)
|
|
- Remove all usage of eval (@mstreuhofer)
|
|
- Get rid of awk, sed & egrep usage (@mstreuhofer)
|
|
- Fix auto-color-off code (#69, @mstreuhofer)
|
|
- Use shellcheck to find and fix unclean code (@mstreuhofer)
|
|
- Allow for multiline opt description in `__usage` (#7, @mstreuhofer)
|
|
- Allow `__usage` and `__helptext` to be defined before sourcing `main.sh` thus makeing b3bp behave like a library (@mstreuhofer)
|
|
- Add the same License text to each script header (@mstreuhofer)
|
|
|
|
## v2.1.0
|
|
|
|
Released: 2016-11-08. [Commit log](https://github.com/kvz/bash3boilerplate/compare/v2.0.0...v2.1.0)
|
|
|
|
- Cleanup b3bp variables (adds prefixes across the board) (thanks @mstreuhofer)
|
|
- Add multi-line logging support (thanks @mstreuhofer)
|
|
- Mangle long-option names to allow dashes (thanks @zbeekman)
|
|
- Remove OS detection altogether (#38, thx @zbeekman)
|
|
- Offer the main template for download as http://bash3boilerplate.sh/main.sh
|
|
- Better OS detection (#38, thx @moviuro)
|
|
- Improve README copy (#34, thx galaktos)
|
|
- Fix unquoted variable access within (#34 thx galaktos)
|
|
- For delete-key-friendliness, bundle the commandline definition block along with its parser
|
|
- Less verbose header comments
|
|
- For delete-key-friendliness, don't crash on undeclared help vars
|
|
- Introduce `errtrace`, which is on by default (BREAKING)
|
|
- Add a configurable `helptext` that is left alone by the parses and allows you to have a richer help
|
|
- Add a simple documentation website
|
|
- Add best practice of using `__double_underscore_prefixed_vars` to indicate global variables that are solely controlled inside your script
|
|
- Make license more permissive by not requiring distribution of the LICENSE file if the copyright & attribution comments are left intact
|
|
- Respect `--no-color` by setting the `NO_COLOR` flag in `main.sh` (#25, thx @gdevenyi)
|
|
- Split out changelog into separate file
|
|
- Added a [FAQ](./FAQ.md) (#15, #14, thanks @rouson)
|
|
- Fix Travis OSX testing (before, it would silently pass failures) (#10)
|
|
- Enable dashes in long, GNU style options, as well as numbers (thanks @zbeekman)
|
|
|
|
## v2.0.0
|
|
|
|
Released: 2016-02-17. [Commit log](https://github.com/kvz/bash3boilerplate/compare/v1.2.1...v2.0.0)
|
|
|
|
- Add tests for `templater` and follow Library export best practices
|
|
- Add tests for `ini_val` and follow Library export best practices
|
|
- Add tests for `parse_url` and follow Library export best practices
|
|
- Add tests for `megamount` and follow Library export best practices
|
|
- Remove `bump` from `src` (BREAKING)
|
|
- Remove `semver` from `src` (BREAKING)
|
|
|
|
## v1.2.1
|
|
|
|
Released: 2016-02-17. [Commit log](https://github.com/kvz/bash3boilerplate/compare/v1.2.0...v1.2.1)
|
|
|
|
- Add Travis CI automated testing for OSX (thanks @zbeekman)
|
|
|
|
## v1.2.0
|
|
|
|
Released: 2016-02-16. [Commit log](https://github.com/kvz/bash3boilerplate/compare/v1.1.0...v1.2.0)
|
|
|
|
- Allow disabling colors via `NO_COLOR` environment variable
|
|
- Enable `errexit`, `nounset` and `pipefail` options at the top of the script already
|
|
- More refined colors (thanks @arathai)
|
|
- Add a changelog to the README
|
|
- Add `__os` magic var (limited to discovering OSX and defaulting to Linux for now)
|
|
- Add `__base` magic var (`main`, if the source script is `main.sh`)
|
|
- Enable long, GNU style options (thanks @zbeekman)
|
|
- Add Travis CI automated testing for Linux
|
|
|
|
## v1.1.0
|
|
|
|
Released: 2015-06-29. [Commit log](https://github.com/kvz/bash3boilerplate/compare/v1.0.3...v1.1.0)
|
|
|
|
- Add `ALLOW_REMAINDERS` configuration to templater
|
|
- Fix typo: 'debugmdoe' to 'debugmode' (thanks @jokajak)
|
|
- Use `${BASH_SOURCE[0]}` for `__file` instead of `${0}`
|
|
|
|
## v1.0.3
|
|
|
|
Released: 2014-11-02. [Commit log](https://github.com/kvz/bash3boilerplate/compare/5db569125319a89b9561b434db84e4d91faefb63...v1.0.3)
|
|
|
|
- Add `ini_val`, `megamount`, `parse_url`
|
|
- Add re-usable libraries in `./src`
|
|
- Use npm as an additional distribution channel
|