bash3boilerplate/changelog/index.html

253 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Changelog | BASH3 Boilerplate Template for writing better Bash scripts | BASH3 Boilerplate</title>
<meta name="keywords" content="bash, template, scripting, command-line">
<meta name="description" content="BASH3 Boilerplate">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,300,600,700' rel='stylesheet' type='text/css'>
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<link href="/assets/build/app.651a09ef8a9b4bbd05bb.css" rel="stylesheet">
</head>
<body>
<header>
<div id="header-overlay"></div>
<a href="/">
<span id="logo"></span>
</a>
<div id="menu">
<i class="material-icons">menu</i>
<ul id="menu-items">
</ul>
</div>
<span id="more">
<i class="material-icons">expand_more</i>
</span>
</header>
<section id="content">
<h1 id="changelog">Changelog</h1>
<p>Heres is a combined todo/done list. You can see what todos are planned for the upcoming release, as well as ideas that may/may not make into a release in <code class="language-plaintext highlighter-rouge">Ideas</code>.</p>
<h2 id="ideas">Ideas</h2>
<p>Unplanned.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" />Better style guide checking (#84)</li>
</ul>
<h2 id="master">master</h2>
<p>Released: TBA.
<a href="https://github.com/kvz/bash3boilerplate/compare/v2.4.2...master">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add feature to edit/update comments in ini file (#132, @rfuehrer)</li>
</ul>
<h2 id="v242">v2.4.2</h2>
<p>Released: 2019-11-07.
<a href="https://github.com/kvz/bash3boilerplate/compare/v2.4.1...v2.4.2">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Upgrade to <code class="language-plaintext highlighter-rouge">lanyon@0.1.16</code></li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Capture correct error_code in err_report (#124, @eval)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Enhanced ini file handling: create new file, create new sections, handle default section, read key from given section (@rfuehrer)</li>
</ul>
<h2 id="v241">v2.4.1</h2>
<p>Released: 2019-11-07.
<a href="https://github.com/kvz/bash3boilerplate/compare/v2.3.0...v2.4.1">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Upgrade to <code class="language-plaintext highlighter-rouge">lanyon@0.1.7</code></li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Allow counting how many times an argument is used (@genesiscloud)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Fix typos in megamount (thanks @gsaponaro)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Enable color in screen or tmux (#92, @gmasse)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Change <code class="language-plaintext highlighter-rouge">egrep</code> to <code class="language-plaintext highlighter-rouge">grep -E</code> in test and lib scripts to comply with ShellCheck (#92, @gmasse)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Fix typo in FAQ (#92, @gmasse)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Fix Travis CI failure on src/templater.sh (@gmasse)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add magic variable which contains full command invocation</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />More contrasted alert and emergency colors (#111 @gmeral)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add support for repeatable arguments (@genesiscloud)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Fix remaining warnings with shellcheck v0.7.0 (#107, @genesiscloud)</li>
</ul>
<h2 id="v240">v2.4.0</h2>
<p>Released: 2016-12-21.
<a href="https://github.com/kvz/bash3boilerplate/compare/v2.3.0...v2.4.0">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Upgrade to <code class="language-plaintext highlighter-rouge">lanyon@0.0.143</code></li>
</ul>
<h2 id="v230">v2.3.0</h2>
<p>Released: 2016-12-21.
<a href="https://github.com/kvz/bash3boilerplate/compare/v2.2.0...v2.3.0">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add magic variable <code class="language-plaintext highlighter-rouge">__i_am_main_script</code> to distinguish if b3bp is being sourced or called directly (#45, @zbeekman)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add style checks for tab characters and trailing whitespace (@zbeekman)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add backtracing to help localize errors (#44, @zbeekman)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Additional FAQ entries (#47, suggested by @gdevenyi, implemented by @zbeekman)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Ensure that shifting over <code class="language-plaintext highlighter-rouge">--</code> doesnt throw an errexit error (#21, @zbeekman)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add Pull Request template (#83)</li>
</ul>
<h2 id="v220">v2.2.0</h2>
<p>Released: 2016-12-21.
<a href="https://github.com/kvz/bash3boilerplate/compare/v2.1.0...v2.2.0">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />README and FAQ improvements (#66, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add support for sourcing b3bp (#61, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Upgrade all Node.js dependencies for development (#78)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Switch to http://lanyon.io for static site building, add a new logo</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Cleanup environment variables (#58, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Support multi-line logs (#57, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Run shellcheck as part of the acceptance test (#79, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Brace all variables, used <code class="language-plaintext highlighter-rouge">[[</code> instead of <code class="language-plaintext highlighter-rouge">[</code> (#33, #76, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add automatic usage validation for required args (#22, #65, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Remove all usage of eval (@mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Get rid of awk, sed &amp; egrep usage (#71, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Fix auto-color-off code (#69, #70, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Use shellcheck to find and fix unclean code (#68, #80, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Allow for multiline opt description in <code class="language-plaintext highlighter-rouge">__usage</code> (#7, @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Allow <code class="language-plaintext highlighter-rouge">__usage</code> and <code class="language-plaintext highlighter-rouge">__helptext</code> to be defined before sourcing <code class="language-plaintext highlighter-rouge">main.sh</code> thus makeing b3bp behave like a library (@mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add the same License text to each script header (@mstreuhofer)</li>
</ul>
<h2 id="v210">v2.1.0</h2>
<p>Released: 2016-11-08.
<a href="https://github.com/kvz/bash3boilerplate/compare/v2.0.0...v2.1.0">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Cleanup b3bp variables (adds prefixes across the board) (thanks @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add multi-line logging support (thanks @mstreuhofer)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Mangle long-option names to allow dashes (thanks @zbeekman)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Remove OS detection altogether (#38, thx @zbeekman)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Offer the main template for download as http://bash3boilerplate.sh/main.sh</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Better OS detection (#38, thx @moviuro)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Improve README copy (#34, thx galaktos)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Fix unquoted variable access within (#34 thx galaktos)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />For delete-key-friendliness, bundle the commandline definition block along with its parser</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Less verbose header comments</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />For delete-key-friendliness, dont crash on undeclared help vars</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Introduce <code class="language-plaintext highlighter-rouge">errtrace</code>, which is on by default (BREAKING)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add a configurable <code class="language-plaintext highlighter-rouge">helptext</code> that is left alone by the parses and allows you to have a richer help</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add a simple documentation website</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add best practice of using <code class="language-plaintext highlighter-rouge">__double_underscore_prefixed_vars</code> to indicate global variables that are solely controlled inside your script</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Make license more permissive by not requiring distribution of the LICENSE file if the copyright &amp; attribution comments are left intact</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Respect <code class="language-plaintext highlighter-rouge">--no-color</code> by setting the <code class="language-plaintext highlighter-rouge">NO_COLOR</code> flag in <code class="language-plaintext highlighter-rouge">main.sh</code> (#25, thx @gdevenyi)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Split out changelog into separate file</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Added a <a href="./FAQ.md">FAQ</a> (#15, #14, thanks @rouson)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Fix Travis OSX testing (before, it would silently pass failures) (#10)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Enable dashes in long, GNU style options, as well as numbers (thanks @zbeekman)</li>
</ul>
<h2 id="v200">v2.0.0</h2>
<p>Released: 2016-02-17.
<a href="https://github.com/kvz/bash3boilerplate/compare/v1.2.1...v2.0.0">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add tests for <code class="language-plaintext highlighter-rouge">templater</code> and follow Library export best practices</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add tests for <code class="language-plaintext highlighter-rouge">ini_val</code> and follow Library export best practices</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add tests for <code class="language-plaintext highlighter-rouge">parse_url</code> and follow Library export best practices</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add tests for <code class="language-plaintext highlighter-rouge">megamount</code> and follow Library export best practices</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Remove <code class="language-plaintext highlighter-rouge">bump</code> from <code class="language-plaintext highlighter-rouge">src</code> (BREAKING)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Remove <code class="language-plaintext highlighter-rouge">semver</code> from <code class="language-plaintext highlighter-rouge">src</code> (BREAKING)</li>
</ul>
<h2 id="v121">v1.2.1</h2>
<p>Released: 2016-02-17.
<a href="https://github.com/kvz/bash3boilerplate/compare/v1.2.0...v1.2.1">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add Travis CI automated testing for OSX (thanks @zbeekman)</li>
</ul>
<h2 id="v120">v1.2.0</h2>
<p>Released: 2016-02-16.
<a href="https://github.com/kvz/bash3boilerplate/compare/v1.1.0...v1.2.0">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Allow disabling colors via <code class="language-plaintext highlighter-rouge">NO_COLOR</code> environment variable</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Enable <code class="language-plaintext highlighter-rouge">errexit</code>, <code class="language-plaintext highlighter-rouge">nounset</code> and <code class="language-plaintext highlighter-rouge">pipefail</code> options at the top of the script already</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />More refined colors (thanks @arathai)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add a changelog to the README</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add <code class="language-plaintext highlighter-rouge">__os</code> magic var (limited to discovering OSX and defaulting to Linux for now)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add <code class="language-plaintext highlighter-rouge">__base</code> magic var (<code class="language-plaintext highlighter-rouge">main</code>, if the source script is <code class="language-plaintext highlighter-rouge">main.sh</code>)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Enable long, GNU style options (thanks @zbeekman)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add Travis CI automated testing for Linux</li>
</ul>
<h2 id="v110">v1.1.0</h2>
<p>Released: 2015-06-29.
<a href="https://github.com/kvz/bash3boilerplate/compare/v1.0.3...v1.1.0">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add <code class="language-plaintext highlighter-rouge">ALLOW_REMAINDERS</code> configuration to templater</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Fix typo: debugmdoe to debugmode (thanks @jokajak)</li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Use <code class="language-plaintext highlighter-rouge">${BASH_SOURCE[0]}</code> for <code class="language-plaintext highlighter-rouge">__file</code> instead of <code class="language-plaintext highlighter-rouge">${0}</code></li>
</ul>
<h2 id="v103">v1.0.3</h2>
<p>Released: 2014-11-02.
<a href="https://github.com/kvz/bash3boilerplate/compare/5db569125319a89b9561b434db84e4d91faefb63...v1.0.3">Diff</a>.</p>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add <code class="language-plaintext highlighter-rouge">ini_val</code>, <code class="language-plaintext highlighter-rouge">megamount</code>, <code class="language-plaintext highlighter-rouge">parse_url</code></li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Add re-usable libraries in <code class="language-plaintext highlighter-rouge">./src</code></li>
<li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled="disabled" checked="checked" />Use npm as an additional distribution channel</li>
</ul>
<p><a href="/">« Home</a></p>
<div class="Social">
<iframe src="http://ghbtns.com/github-btn.html?user=kvz&repo=bash3boilerplate&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>
</div>
<p>
<small>
<hr />
Website design based on
the wonderful <a href="http://apex.run">apex.run</a>
with <a href="https://twitter.com/tjholowaychuk/status/744909762865696769">the author's consent</a>.
</small>
</p>
</section>
</body>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.1.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.1.0/languages/bash.min.js"></script>
<script src="/assets/build/app.5c7edb9a417afd6fed50.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-63083-13', 'auto');
ga('send', 'pageview');
</script>
</html>