From bde2b428e9d608df47ff6f372beb319e50751b10 Mon Sep 17 00:00:00 2001 From: Hugh Saunders Date: Wed, 4 Mar 2020 15:26:03 +0000 Subject: [PATCH] Add CHANGELOG This changelog is maintained according to the format specified by keepachangelog. Related: #24 --- CHANGELOG.md | 34 ++++++++++++++++++++++++++++++++++ CHANGES.md | 10 ---------- Jenkinsfile | 6 ++++++ 3 files changed, 40 insertions(+), 10 deletions(-) create mode 100644 CHANGELOG.md delete mode 100644 CHANGES.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..29b3046 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,34 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [2.0.1] - 2020-02-19 +### Added +- Github issue related functions via the `hub` cli + +### Changed +- Helpers lib now uses bash-lib logging functions + +### Fixed +- Ensured that all variables used within bash-lib functions are declared as local + +## [2.0.0] - 2020-01-17 +### Added +- Logging Functions, with basic log level support +- Retry Constant function for when you want to retry but don't want increasing + backoff. + +### Changed +- Prefixed all function names with bl_ to prevent name clashes with builtins + and other libraries. +- Libraries are now loaded by the init script, so they don't need to be + sourced individually. + +## [1.0.0] - 2019-11-20 +### Added +- filehandling, git, helpers, k8s, logging and test-utils libraries +- Test Suite diff --git a/CHANGES.md b/CHANGES.md deleted file mode 100644 index a489587..0000000 --- a/CHANGES.md +++ /dev/null @@ -1,10 +0,0 @@ -# Changelog - -## V2 -* V2.0.0 - * Renamed all functions to include bl_ prefix - * Added bl_retry_constant - * Added bl_debug, bl_info, bl_warning, bl_error and bl_fatal logging functions - -## V1 -* v1.0.0: Initial Release \ No newline at end of file diff --git a/Jenkinsfile b/Jenkinsfile index 33900a4..b225d33 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -18,6 +18,12 @@ pipeline { stages { + stage('Validate Changelog'){ + steps{ + parseChangelog() + } + } + stage('BATS Tests') { steps { sh './tests-for-this-repo/run-bats-tests'