v1.0.0

Modules Effected

• No changes with this release, moving to v1.x.x SemVer standard

Overview

This release marks a significant milestone for the module 🎉
We are officially adopting the Semantic Versioning (SemVer) standard, starting with version v1.0.0. Prior to this release, version tags only incremented patch and minor numbers. Moving forward, all releases should fully comply with the SemVer specification, providing clearer expectations for users regarding changes, compatibility, and upgrade paths.

Stable Library Module

With the v1.0.0 release, the library module is considered stable. This means that all subsequent changes in the v1.x.x series will be backward-compatible unless a new major version (v2.0.0) is released.

Predictable Versioning

Version numbers will now follow the format MAJOR.MINOR.PATCH

• MAJOR: Incremented for breaking changes or incompatible API changes.
• MINOR: Incremented for new, backward-compatible features.
• PATCH: Incremented for backward-compatible bug fixes.

Backward Compatibility

Users can now rely on the v1.x.x series to remain backward-compatible. Breaking changes should only occur in a future v2.0.0 release.

Communication of Changes

Each release will include detailed notes indicating whether changes are breaking, additive, or bug fixes, as per SemVer guidelines.

v0.2.4

Modules affected

• bash-commons

Description

• Add centos stream to OS check function

v0.2.3

Modules affected

• bash-commons

Description

• Remove EOL Ubuntu 16.04 and 18.04 tests
• Add tests for Ubuntu 22.04

v0.2.2

Modules affected

• bash-commons

Description

• Default to IMDSv2 if no override set
  • The calling script can override this by setting either of the two variables:
    • GRUNTWORK_BASH_COMMONS_IMDS_VERSION
    • default_instance_metadata_version
• Improved metadata availability detection

v0.2.1

Modules affected

• bash-commons

Description

• Fixed unbound variable bug in modules/bash-commons/src/aws.sh

v0.2.0

Modules affected

• bash-commons

Description

Update to use IMDSv2 by default (still supports manually setting v1 if needed)

IMPORTANT

There is a bug modules/bash-commons/src/aws.sh that will result in an unbound variable error if GRUNTWORK_BASH_COMMONS_IMDS_VERSION is undefined. This is fixed in v0.2.1.

v0.1.9

Modules affected

• log.sh

Description

Added convenience function for echo-ing to stderr.

v0.1.8

Modules affected

• aws.sh

Description

Introduce support for AWS Instance Metadata Service (IMDS) Version 2. These changes are fully backward compatible, and bash-commons continues to default to Version 1 of the Instance Metadata Service.

You can override the version of IMDS that bash-commons contacts by setting the following environment variable:

GRUNTWORK_BASH_COMMONS_IMDS_VERSION="2"

bash-commons will continue to default to IMDSv1 until we have migrated all our dependent modules to use version 2. Once this migration is complete, we will issue another release that updates bash-commons to use IMDSv2 by default.

For more information on the differences between Instance Metadata Service Versions 1 and 2 see here.

v0.1.7

Modules affected

• assert.sh
• string.sh

Description

• Introduce assert_user_has_sudo_perms which checks if user has permissions to run sudo.
• Introduce string_substr which can extract a substring by index.

Related links

• #37

v0.1.6

Modules affected

• os.sh

Description

• Fix bug introduced with using sudo for the os_create_user and os_change_dir_owner functions.

Related links

• #36