Merge pull request #38 from mineiros-io/mariux/changelog-cleanup

chore: Clean CHANGELOG.md

Author: mariux

CHANGELOG.md

@@ -1,4 +1,5 @@
 # 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/),
@@ -7,31 +8,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ## [0.6.0]
+
 ### Added
-- feat: feat: add support for Terraform `v0.15`
 
-### Changed
-- feat: upgrade terratest to `v1.34.0`
-- build: upgrade build-tools to `v0.11.0`
-- build: upgrade pre-commit-hooks to `v0.2.3`
+- Add support for Terraform `v0.15`
 
 ## [0.5.0]
+
 ### Added
+
 - Add support for `account_recovery_mechanisms`
 
 ### Removed
-- BREAKING CHANGE: Drop support for Terraform AWS Provider version 2.x
+
+- BREAKING CHANGE: Drop support for Terraform AWS Provider version `v2`
 
 ## [0.4.1] - 2021-02-08
+
 ### Fixed
+
 - Fixed examples to use new variable `user_device_tracking` instead of `device_only_remembered_on_user_prompt`
 
 ## [0.4.0] - 2020-12-09
+
 ### Changed
+
 - Add support for Terraform v0.14
 
 ## [0.3.0] - 2020-11-25
+
 ### Changes
+
 - Add argument `user_device_tracking` to set device tracking to `OFF`, `ALWAYS` or `USER_OPT_IN`
 - BREAKING CHANGE: Remove argument `device_only_remembered_on_user_prompt`. Replaced by `user_device_tracking`.
   Default behavior did not change. How to migrate:
@@ -40,58 +47,81 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `device_only_remembered_on_user_prompt=null`: Set `user_device_tracking='OFF'`
 
 ### Fixes
+
 - Allow to cleanly turn off user device tracking by setting new variable `user_device_tracking` to `OFF`. [#23](https://github.com/mineiros-io/terraform-aws-cognito-user-pool/issues/23)
 - The type of the clients output is a map of objects instead of a list.
 
 ## [0.2.0] - 2020-08-13
+
 ### Changed
-- Add support for Terraform v0.13
-- Prepared support for Terraform v0.14
+
+- Add support for Terraform `v0.13`
+- Prepared support for Terraform `v0.14`
 
 ## [0.1.4] - 2020-08-13
+
 ### Added
+
 - Add support for `username_attributes` argument.
 
 ## [0.1.3] - 2020-08-10
+
 ### Added
+
 - Add unit test coverage for the `aws_cognito_user_pool_domain` resource.
+
 ### Changed
+
 - Enable `markdown-link-check` pre-commit hook.
+
 ### Fixed
+
 - Fixes recreation of resources on multiple apply runs.
 - Fix non-idempotent number schema attributes.
 
 ## [0.1.2] - 2020-08-05
+
 ### Added
+
 - Add support for `aws_cognito_user_pool_domain`.
 
 ## [0.1.1] - 2020-08-04
+
 ### Fixed
+
 - Fix email subject for admin invites.
 - Fix example documentation to point to terraform registry.
 - Fix `string_attribute_constraints` default values for string attributes to prevent non-idempotent plan.
 
 ### Added
+
 - Add test to validate idempotency after apply.
 
 ## [0.1.0] - 2020-08-03
+
 ### Changed
-- Add support for terraform aws provider 3.x.
-- Update test to test against 3.0 aws provider.
-- Update test dependencies to use 3.x capable module versions.
+
+- Add support for terraform aws provider `v3`
+- Update test to test against `v3` aws provider
+- Update test dependencies to use `v3` capable module versions
 
 ## [0.0.1] - 2020-06-27
+
 ### Added
+
 - Implement support for `aws_cognito_user_pool` resource.
 - Implement support for `aws_cognito_user_pool_client` resource.
 - Document the usage of the module in README.md.
 - Document the usage of examples.
 - Add unit tests for basic use cases.
 
 <!-- markdown-link-check-disable -->
-[Unreleased]: https://github.com/mineiros-io/terraform-aws-cognito-user-pool/compare/v0.5.1...HEAD
+
+[unreleased]: https://github.com/mineiros-io/terraform-aws-cognito-user-pool/compare/v0.5.1...HEAD
 [0.5.1]: https://github.com/mineiros-io/terraform-aws-cognito-user-pool/compare/v0.5.0...v0.5.1
+
 <!-- markdown-link-check-enable -->
+
 [0.5.0]: https://github.com/mineiros-io/terraform-aws-cognito-user-pool/compare/v0.4.1...v0.5.0
 [0.4.1]: https://github.com/mineiros-io/terraform-aws-cognito-user-pool/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/mineiros-io/terraform-aws-cognito-user-pool/compare/v0.3.0...v0.4.0

Makefile

@@ -5,10 +5,13 @@ BUILD_TOOLS_VERSION      ?= v0.11.0
 BUILD_TOOLS_DOCKER_REPO  ?= mineiros/build-tools
 BUILD_TOOLS_DOCKER_IMAGE ?= ${BUILD_TOOLS_DOCKER_REPO}:${BUILD_TOOLS_VERSION}
 
-# If running in CI (e.g. GitHub Actions)
-# https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables
 #
-# To disable TF_IN_AUTOMATION in CI set it to empty
+# Some CI providers such as GitHub Actions, CircleCI, and TravisCI are setting
+# the CI environment variable to a non-empty value by default to indicate that
+# the current workflow is running in a Continuous Integration environment.
+#
+# If TF_IN_AUTOMATION is set to any non-empty value, Terraform adjusts its
+# output to avoid suggesting specific commands to run next.
 # https://www.terraform.io/docs/commands/environment-variables.html#tf_in_automation
 #
 # We are using GNU style quiet commands to disable set V to non-empty e.g. V=1
@@ -28,18 +31,16 @@ ifndef NOCOLOR
 	RESET  := $(shell tput -Txterm sgr0)
 endif
 
-# We are creating docker volumes for /go and /terraform that are unique per
-# repository to reuse dependencies between different docker run commands.
-VOLUME_PREFIX ?= mineiros_build_tools
-VOLUME_SUFFIX ?= $(notdir $(shell git rev-parse --show-toplevel || "build"))
-DOCKER_RUN_FLAGS += -v ${VOLUME_PREFIX}-terraform-${VOLUME_SUFFIX}:/terraform
-DOCKER_RUN_FLAGS += -v ${VOLUME_PREFIX}-go-${VOLUME_SUFFIX}:/go
-DOCKER_RUN_FLAGS += -v ${PWD}:/build
+GIT_TOPLEVEl = $(shell git rev-parse --show-toplevel)
+
+DOCKER_RUN_FLAGS += -v ${GIT_TOPLEVEl}:/build
 DOCKER_RUN_FLAGS += --rm
 DOCKER_RUN_FLAGS += -e TF_IN_AUTOMATION
 
-DOCKER_SSH_FLAGS += -e SSH_AUTH_SOCK=/ssh-agent
-DOCKER_SSH_FLAGS += -v ${SSH_AUTH_SOCK}:/ssh-agent
+ifdef SSH_AUTH_SOCK
+  DOCKER_SSH_FLAGS += -e SSH_AUTH_SOCK=/ssh-agent
+  DOCKER_SSH_FLAGS += -v ${SSH_AUTH_SOCK}:/ssh-agent
+endif
 
 DOCKER_AWS_FLAGS += -e AWS_ACCESS_KEY_ID
 DOCKER_AWS_FLAGS += -e AWS_SECRET_ACCESS_KEY
@@ -76,9 +77,11 @@ test/unit-tests:
 .PHONY: clean
 clean:
 	$(call rm-command,.terraform)
+	$(call rm-command,.terraform.lock.hcl)
 	$(call rm-command,*.tfplan)
 	$(call rm-command,*/*/.terraform)
 	$(call rm-command,*/*/*.tfplan)
+	$(call rm-command,*/*/.terraform.lock.hcl)
 
 ## Display help for all targets
 .PHONY: help