mirror of https://github.com/kvz/bash3boilerplate.git synced 2024-12-18 22:27:51 +00:00

Manuel Streuhofer d383e8c098 prepared changelog for release 2.2.0 (#82 )

moved entries in changelog from `unreleased` to 2.1.0 (even
though technically it's too late for that since that version was already
released).

added new section for 2.2.0 and added some points on what changed.

bumped version to 2.2.0 in main.sh, example.sh and package.json

Closes #74

2016-12-21 09:29:02 +01:00

4.2 KiB

Raw Blame History

Changelog

master

Released: Unreleased. Commit log

v2.2.0

Released: 2016-12-XX. Commit log

run shellcheck as part of the acceptance test. Closes #79 (@mstreuhofer)
brace all variables, used [[ instead of [. Closes #33 (@mstreuhofer)
added automatic usage validation for required args. Closes #22 (@mstreuhofer)
removed all usage of eval (@mstreuhofer)
get rid of awk, sed & egrep usage (@mstreuhofer)
fix auto-color-off code. Fixes #69 (@mstreuhofer)
used shellcheck to find and fix unclean code (@mstreuhofer)
Allow for multiline opt description in __usage. Fixes #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

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 (#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

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

Add Travis CI automated testing for OSX (thanks @zbeekman)

v1.2.0

Released: 2016-02-16. Commit log

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

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

Add ini_val, megamount, parse_url
Add re-usable libraries in ./src
Use npm as an additional distribution channel

4.2 KiB Raw Blame History