mirror of
https://github.com/kvz/bash3boilerplate.git
synced 2024-12-24 16:36:40 +00:00
Split out changelog into separate file, credit @rouson for the FAQ
This commit is contained in:
parent
bbd4b7689b
commit
8687e384eb
46
CHANGELOG.md
Normal file
46
CHANGELOG.md
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
Please see the [CHANGELOG.md](./CHANGELOG.md) file.
|
||||||
|
|
||||||
|
## master (Unreleased)
|
||||||
|
|
||||||
|
- 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 (2016-02-17)
|
||||||
|
|
||||||
|
- 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 (2016-02-17)
|
||||||
|
|
||||||
|
- Add Travis CI automated testing for OSX (thanks @zbeekman)
|
||||||
|
|
||||||
|
## v1.2.0 (2016-02-16)
|
||||||
|
|
||||||
|
- 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 (2015-06-29)
|
||||||
|
|
||||||
|
- 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 (2014-11-02)
|
||||||
|
|
||||||
|
- Add `ini_val`, `megamount`, `parse_url`
|
||||||
|
- Add re-usable libraries in `./src`
|
||||||
|
- Use npm as an additional distribution channel
|
46
README.md
46
README.md
@ -67,46 +67,7 @@ Although *3* introduces a node.js dependency, this does allow for easy version p
|
|||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
|
|
||||||
### master (Unreleased)
|
Please see the [CHANGELOG.md](./CHANGELOG.md) file.
|
||||||
|
|
||||||
- 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 (2016-02-17)
|
|
||||||
|
|
||||||
- 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 (2016-02-17)
|
|
||||||
|
|
||||||
- Add Travis CI automated testing for OSX (thanks @zbeekman)
|
|
||||||
|
|
||||||
### v1.2.0 (2016-02-16)
|
|
||||||
|
|
||||||
- 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 (2015-06-29)
|
|
||||||
|
|
||||||
- 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 (2014-11-02)
|
|
||||||
|
|
||||||
- Add `ini_val`, `megamount`, `parse_url`
|
|
||||||
- Add re-usable libraries in `./src`
|
|
||||||
- Use npm as an additional distribution channel
|
|
||||||
|
|
||||||
## Best practices
|
## Best practices
|
||||||
|
|
||||||
@ -148,9 +109,10 @@ Please see the [FAQ.md](./FAQ.md) file.
|
|||||||
|
|
||||||
## Authors
|
## Authors
|
||||||
|
|
||||||
- [Kevin van Zonneveld](<http://kvz.io>)
|
- [Kevin van Zonneveld](http://kvz.io)
|
||||||
- [Izaak Beekman](<https://izaakbeekman.com/>)
|
- [Izaak Beekman](https://izaakbeekman.com/)
|
||||||
- [Alexander Rathai](mailto:<Alexander.Rathai@gmail.com>)
|
- [Alexander Rathai](mailto:<Alexander.Rathai@gmail.com>)
|
||||||
|
- [Dr. Damian Rouson](http://www.sourceryinstitute.org/) (documentation)
|
||||||
|
|
||||||
## Sponsoring
|
## Sponsoring
|
||||||
|
|
||||||
|
1
main.sh
1
main.sh
@ -18,6 +18,7 @@
|
|||||||
# - Kevin van Zonneveld (http://kvz.io)
|
# - Kevin van Zonneveld (http://kvz.io)
|
||||||
# - Izaak Beekman (https://izaakbeekman.com/)
|
# - Izaak Beekman (https://izaakbeekman.com/)
|
||||||
# - Alexander Rathai (Alexander.Rathai@gmail.com)
|
# - Alexander Rathai (Alexander.Rathai@gmail.com)
|
||||||
|
# - Dr. Damian Rouson (http://www.sourceryinstitute.org/) (documentation)
|
||||||
#
|
#
|
||||||
# Usage:
|
# Usage:
|
||||||
#
|
#
|
||||||
|
Loading…
Reference in New Issue
Block a user