bats-core · mbland · Jul 9, 2018 · Jul 9, 2018 · Jul 9, 2018
@@ -434,122 +434,7 @@ on the wiki.
 
 ## Version history
 
-Bats is [SemVer compliant](https://semver.org/).
-
-*1.1.0* (July 8, 2018)
-
-This is the first release with new features relative to the original Bats 0.4.0.
-
-Added:
-* The `-r, --recursive` flag to scan directory arguments recursively for
-  `*.bats` files (#109)
-* The `contrib/rpm/bats.spec` file to build RPMs (#111)
-
-Changed:
-* Travis exercises latest versions of Bash from 3.2 through 4.4 (#116, #117)
-* Error output highlights invalid command line options (#45, #46, #118)
-* Replaced `echo` with `printf` (#120)
-
-Fixed:
-* Fixed `BATS_ERROR_STATUS` getting lost when `bats_error_trap` fired multiple
-  times under Bash 4.2.x (#110)
-* Updated `bin/bats` symlink resolution, handling the case on CentOS where
-  `/bin` is a symlink to `/usr/bin` (#113, #115)
-
-*1.0.2* (June 18, 2018)
-
-* Fixed sstephenson/bats#240, whereby `skip` messages containing parentheses
-  were truncated (#48)
-* Doc improvements:
-  * Docker usage (#94)
-  * Better README badges (#101)
-  * Better installation instructions (#102, #104)
-* Packaging/installation improvements:
-  * package.json update (#100)
-  * Moved `libexec/` files to `libexec/bats-core/`, improved `install.sh` (#105)
-
-*1.0.1* (June 9, 2018)
-
-* Fixed a `BATS_CWD` bug introduced in #91 whereby it was set to the parent of
-  `PWD`, when it should've been set to `PWD` itself (#98). This caused file
-  names in stack traces to contain the basename of `PWD` as a prefix, when the
-  names should've been purely relative to `PWD`.
-* Ensure the last line of test output prints when it doesn't end with a newline
-  (#99). This was a quasi-bug introduced by replacing `sed` with `while` in #88.
-
-*1.0.0* (June 8, 2018)
-
-`1.0.0` generally preserves compatibility with `0.4.0`, but with some Bash
-compatibility improvements and a massive performance boost. In other words:
-
-- all existing tests should remain compatible
-- tests that might've failed or exhibited unexpected behavior on earlier
-  versions of Bash should now also pass or behave as expected
-
-Changes:
-
-* Added support for Docker.
-* Added support for test scripts that have the [unofficial strict
-  mode](http://redsymbol.net/articles/unofficial-bash-strict-mode/) enabled.
-* Improved stability on Windows and macOS platforms.
-* Massive performance improvements, especially on Windows (#8)
-* Workarounds for inconsistent behavior between Bash versions (#82)
-* Workaround for preserving stack info after calling an exported function under
-  Bash < 4.4 (#87)
-* Fixed TAP compliance for skipped tests
-* Added support for tabs in test names.
-* `bin/bats` and `install.sh` now work reliably on Windows (#91)
-
-*0.4.0* (August 13, 2014)
-
-* Improved the display of failing test cases. Bats now shows the source code of
-  failing test lines, along with full stack traces including function names,
-  filenames, and line numbers.
-* Improved the display of the pretty-printed test summary line to include the
-  number of skipped tests, if any.
-* Improved the speed of the preprocessor, dramatically shortening test and suite
-  startup times.
-* Added support for absolute pathnames to the `load` helper.
-* Added support for single-line `@test` definitions.
-* Added bats(1) and bats(7) manual pages.
-* Modified the `bats` command to default to TAP output when the `$CI` variable
-  is set, to better support environments such as Travis CI.
-
-*0.3.1* (October 28, 2013)
-
-* Fixed an incompatibility with the pretty formatter in certain environments
-  such as tmux.
-* Fixed a bug where the pretty formatter would crash if the first line of a test
-  file's output was invalid TAP.
-
-*0.3.0* (October 21, 2013)
-
-* Improved formatting for tests run from a terminal. Failing tests are now
-  colored in red, and the total number of failing tests is displayed at the end
-  of the test run. When Bats is not connected to a terminal (e.g. in CI runs),
-  or when invoked with the `--tap` flag, output is displayed in standard TAP
-  format.
-* Added the ability to skip tests using the `skip` command.
-* Added a message to failing test case output indicating the file and line
-  number of the statement that caused the test to fail.
-* Added "ad-hoc" test suite support. You can now invoke `bats` with multiple
-  filename or directory arguments to run all the specified tests in aggregate.
-* Added support for test files with Windows line endings.
-* Fixed regular expression warnings from certain versions of Bash.
-* Fixed a bug running tests containing lines that begin with `-e`.
-
-*0.2.0* (November 16, 2012)
-
-* Added test suite support. The `bats` command accepts a directory name
-  containing multiple test files to be run in aggregate.
-* Added the ability to count the number of test cases in a file or suite by
-  passing the `-c` flag to `bats`.
-* Preprocessed sources are cached between test case runs in the same file for
-  better performance.
-
-*0.1.0* (December 30, 2011)
-
-* Initial public release.
+See `docs/CHANGELOG.md`.
 
 ---
 

@@ -0,0 +1,137 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog][kac] and this project adheres to
+[Semantic Versioning][semver].
+
+[kac]: https://keepachangelog.com/en/1.0.0/
+[semver]: https://semver.org/
+
+## [Unreleased]
+
+## [1.1.0] - 2018-07-08
+
+This is the first release with new features relative to the original Bats 0.4.0.
+
+### Added
+* The `-r, --recursive` flag to scan directory arguments recursively for
+  `*.bats` files (#109)
+* The `contrib/rpm/bats.spec` file to build RPMs (#111)
+
+### Changed
+* Travis exercises latest versions of Bash from 3.2 through 4.4 (#116, #117)
+* Error output highlights invalid command line options (#45, #46, #118)
+* Replaced `echo` with `printf` (#120)
+
+### Fixed
+* Fixed `BATS_ERROR_STATUS` getting lost when `bats_error_trap` fired multiple
+  times under Bash 4.2.x (#110)
+* Updated `bin/bats` symlink resolution, handling the case on CentOS where
+  `/bin` is a symlink to `/usr/bin` (#113, #115)
+
+## [1.0.2] - 2018-06-18
+
+* Fixed sstephenson/bats#240, whereby `skip` messages containing parentheses
+  were truncated (#48)
+* Doc improvements:
+  * Docker usage (#94)
+  * Better README badges (#101)
+  * Better installation instructions (#102, #104)
+* Packaging/installation improvements:
+  * package.json update (#100)
+  * Moved `libexec/` files to `libexec/bats-core/`, improved `install.sh` (#105)
+
+## [1.0.1] - 2018-06-09
+
+* Fixed a `BATS_CWD` bug introduced in #91 whereby it was set to the parent of
+  `PWD`, when it should've been set to `PWD` itself (#98). This caused file
+  names in stack traces to contain the basename of `PWD` as a prefix, when the
+  names should've been purely relative to `PWD`.
+* Ensure the last line of test output prints when it doesn't end with a newline
+  (#99). This was a quasi-bug introduced by replacing `sed` with `while` in #88.
+
+## [1.0.0] - 2018-06-08
+
+`1.0.0` generally preserves compatibility with `0.4.0`, but with some Bash
+compatibility improvements and a massive performance boost. In other words:
+
+- all existing tests should remain compatible
+- tests that might've failed or exhibited unexpected behavior on earlier
+  versions of Bash should now also pass or behave as expected
+
+Changes:
+
+* Added support for Docker.
+* Added support for test scripts that have the [unofficial strict
+  mode](http://redsymbol.net/articles/unofficial-bash-strict-mode/) enabled.
+* Improved stability on Windows and macOS platforms.
+* Massive performance improvements, especially on Windows (#8)
+* Workarounds for inconsistent behavior between Bash versions (#82)
+* Workaround for preserving stack info after calling an exported function under
+  Bash < 4.4 (#87)
+* Fixed TAP compliance for skipped tests
+* Added support for tabs in test names.
+* `bin/bats` and `install.sh` now work reliably on Windows (#91)
+
+## [0.4.0] - 2014-08-13
+
+* Improved the display of failing test cases. Bats now shows the source code of
+  failing test lines, along with full stack traces including function names,
+  filenames, and line numbers.
+* Improved the display of the pretty-printed test summary line to include the
+  number of skipped tests, if any.
+* Improved the speed of the preprocessor, dramatically shortening test and suite
+  startup times.
+* Added support for absolute pathnames to the `load` helper.
+* Added support for single-line `@test` definitions.
+* Added bats(1) and bats(7) manual pages.
+* Modified the `bats` command to default to TAP output when the `$CI` variable
+  is set, to better support environments such as Travis CI.
+
+## [0.3.1] - 2013-10-28
+
+* Fixed an incompatibility with the pretty formatter in certain environments
+  such as tmux.
+* Fixed a bug where the pretty formatter would crash if the first line of a test
+  file's output was invalid TAP.
+
+## [0.3.0] - 2013-10-21
+
+* Improved formatting for tests run from a terminal. Failing tests are now
+  colored in red, and the total number of failing tests is displayed at the end
+  of the test run. When Bats is not connected to a terminal (e.g. in CI runs),
+  or when invoked with the `--tap` flag, output is displayed in standard TAP
+  format.
+* Added the ability to skip tests using the `skip` command.
+* Added a message to failing test case output indicating the file and line
+  number of the statement that caused the test to fail.
+* Added "ad-hoc" test suite support. You can now invoke `bats` with multiple
+  filename or directory arguments to run all the specified tests in aggregate.
+* Added support for test files with Windows line endings.
+* Fixed regular expression warnings from certain versions of Bash.
+* Fixed a bug running tests containing lines that begin with `-e`.
+
+## [0.2.0] - 2012-11-16
+
+* Added test suite support. The `bats` command accepts a directory name
+  containing multiple test files to be run in aggregate.
+* Added the ability to count the number of test cases in a file or suite by
+  passing the `-c` flag to `bats`.
+* Preprocessed sources are cached between test case runs in the same file for
+  better performance.
+
+## [0.1.0] - 2011-12-30
+
+* Initial public release.
+
+[Unreleased]: https://github.com/bats-core/bats-core/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/bats-core/bats-core/compare/v1.0.2...v1.1.0
+[1.0.2]: https://github.com/bats-core/bats-core/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/bats-core/bats-core/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/bats-core/bats-core/compare/v0.4.0...v1.0.0
+[0.4.0]: https://github.com/bats-core/bats-core/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/bats-core/bats-core/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/bats-core/bats-core/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/bats-core/bats-core/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/bats-core/bats-core/commits/v0.1.0
@@ -0,0 +1,128 @@
+# Releasing a new Bats version
+
+These notes reflect the current process. There's a lot more we could do, in
+terms of automation and expanding the number of platforms to which we formally
+release (see #103).
+
+## Update docs/CHANGELOG.md
+
+Create a new entry at the top of `docs/CHANGELOG.md` that enumerates the
+significant updates to the new version.
+
+## Bumping the version number
+
+Bump the version numbers in the following files:
+
+- .appveyor.yml
+- contrib/rpm/bats.spec
+- libexec/bats-core/bats
+- package.json
+
+Commit these changes (including the `docs/CHANGELOG.md` changes) in a commit
+with the message `Bats <VERSION>`, where `<VERSION>` is the new version number.
+
+Create a new signed, annotated tag with:
+
+```bash
+$ git tag -a -s <VERSION>
+```
+
+Include the `docs/CHANGELOG.md` notes corresponding to the new version as the
+tag annotation, except the first line should be: `Bats <VERSION> - YYYY-MM-DD`
+and any Markdown headings should become plain text, e.g.:
+
+```md
+### Added
+```
+
+should become:
+
+```md
+Added:
+```
+
+## Create a GitHub release
+
+Push the new version commit and tag to GitHub via the following:
+
+```bash
+$ git push --follow-tags
+```
+
+Then visit https://github.com/bats-core/bats-core/releases, and:
+
+* Click **Draft a new release**.
+* Select the new version tag.
+* Name the release: `Bats <VERSION>`.
+* Paste the same notes from the version tag annotation as the description,
+  except change the first line to read: `Released: YYYY-MM-DD`.
+* Click **Publish release**.
+
+For more on `git push --follow-tags`, see:
+
+* [git push --follow-tags in the online manual][ft-man]
+* [Stack Overflow: How to push a tag to a remote repository using Git?][ft-so]
+
+[ft-man]: https://git-scm.com/docs/git-push#git-push---follow-tags
+[ft-so]: https://stackoverflow.com/a/26438076
+
+## NPM
+
+`npm publish`. Pretty easy!
+
+For the paranoid, use `npm pack` and install the resulting tarball locally with
+`npm install` before publishing.
+
+## Homebrew
+
+The basic instructions are in the [Submit a new version of an existing
+formula][brew] section of the Homebrew docs.
+
+[brew]: https://github.com/Homebrew/brew/blob/master/docs/How-To-Open-a-Homebrew-Pull-Request.md#submit-a-new-version-of-an-existing-formula
+
+An example using v1.1.0 (notice that this uses the sha256 sum of the tarball):
+
+```bash
+$ curl -LOv https://github.com/bats-core/bats-core/archive/v1.1.0.tar.gz
+$ openssl sha256 v1.1.0.tar.gz
+SHA256(v1.1.0.tar.gz)=855d8b8bed466bc505e61123d12885500ef6fcdb317ace1b668087364717ea82
+
+# Add the --dry-run flag to see the individual steps without executing.
+$ brew bump-formula-pr \
+  --url=https://github.com/bats-core/bats-core/archive/v1.1.0.tar.gz \
+  --sha256=855d8b8bed466bc505e61123d12885500ef6fcdb317ace1b668087364717ea82
+```
+This resulted in https://github.com/Homebrew/homebrew-core/pull/29864, which was
+automatically merged once the build passed.
+
+## Alpine Linux
+
+An example using v1.1.0 (notice that this uses the sha512 sum of the Zip file):
+
+```bash
+$ curl -LOv https://github.com/bats-core/bats-core/archive/v1.1.0.zip
+$ openssl sha512 v1.1.0.zip
+SHA512(v1.1.0.zip)=accd83cfec0025a2be40982b3f9a314c2bbf72f5c85daffa9e9419611904a8d34e376919a5d53e378382e0f3794d2bd781046d810225e2a77812474e427bed9e
+```
+
+After cloning alpinelinux/aports, I used the above information to create:
+https://github.com/alpinelinux/aports/pull/4696
+
+**Note:** Currently users must enable the `edge` branch of the `community` repo
+by adding/uncommenting the corresponding entry in `/etc/apk/repositories`.
+
+## Announce
+
+It's worth making a brief announcement like [the v1.1.0 announcement via
+Gitter][gitter]:
+
+[gitter]: https://gitter.im/bats-core/bats-core?at=5b42c9a57b811a6d63daacb5
+
+```
+v1.1.0 is now available via Homebrew and npm:
+https://github.com/bats-core/bats-core/releases/tag/v1.1.0
+
+It'll eventually be available in Alpine via the edge branch of the community
+repo once alpinelinux/aports#4696 gets merged. (Check /etc/apk/repositories to
+ensure this repo is enabled.)
+```