Shell Script Library / CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[2.3.2] - 2018-04-26

Fixed

  • Fixed missing trailing newline in k_requires_args
  • Fixed typo in k-script-build --help output
  • Fix current directory issue in k-script-build when source is passed by stdin

[2.3.1] - 2018-04-05

Fixed

  • Include Vagrantfile, install-deps and full tool sources in Release archive

[2.3.0] - 2018-04-03

Added

  • Initial test for gpg.lib.sh module

Changed

  • Added a third parameter, group to k_fs_perms_useronly

Fixed

  • Use a default fallback value of 'false' in k_bool_test
  • Improved return code handling in k_bool_valid and k_gpg_create
  • Fix a bug when no user/group is specified for k_fs_perms_useronly
  • Fix a bug where k_log_* messages could result in a loop.
  • Fixed a build system issue where GPG path wasn't being set properly
  • Fixed shellcheck reported issues in gpg.lib.sh

[2.2.0] - 2018-04-02

Added

  • k_fs_extension function to get the extension part of a filesystem path
  • k-script-build now accepts an -M/--make-deps flag to output a Make compatible rule defining a scripts direct dependencies
  • k-script-build now accepts an -R/--report-replaced flag to output sourced files similar to -r/--report but with prefix replacements applied.
  • Makefile target 'shellcheck' to run source scripts through shellcheck
  • k-help2man now exports K_HELP2MAN_BUILD with a value of 1, so tools can alter help output for use by man pages
  • k-shell-doc now correctly parses local and readonly variables, and tags readonly variables as such

Changed

  • install-deps.sh now accepts --dev to install build dependencies
  • k-script-build no longer requires or is affected by the -c/-cd flag. Different relative paths are now handled automatically
  • k-script-build -h/--help output and man page include a detailed description of the three modes of operation.
  • k-shell-doc -h/--help output and man page include a detailed description of the expected format for shelldoc comments.
  • k-shell-doc can now disable Markdown Extra 'heading ID' syntax using --md-extra-ids off.
  • k_bool_keyword & k_bool_status gained extra debug logging

Fixed

  • Make gpg and cfget detection work better with $PATH
  • Clean up configure script code style
  • Include vendor name in release archive filename
  • Updated k-shell-doc to properly handle blank links in function descriptions
  • Updated k_bool_parse to use 'false'`as default
  • Updated k_bool_keyword to parse 'false' properly
  • Updated k_fs_perms_useronly to resolve shellcheck issues

[2.1.0] - 2018-03-21

Added

  • Make SYS_CONF_DIR available in Makefile
  • Make PACKAGE_NAME and PACKAGE_VERSION available in source script
  • k_fs_register_temp_file to register a file for cleanup by k_fs_temp_cleanup
  • k_fs_perms_useronly to set ownership & permissions of a file/directory
  • install-deps.sh script

Changed

  • Accept a second parameter in k_fs_predictable_file and k_fs_predictable_dir, to set a suffix

[2.0.0] - 2018-03-19

Added

Changed

  • Fixes to pass (or override where appropriate) shellcheck tests