Merge pull request #14 from mineiros-io/mariux/prepare-release

Prepare minor release
mineiros-io · Jul 8, 2020 · f21b501 · f21b501
2 parents 65f9625 + daffb81
commit f21b501
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,45 @@
+# 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]
+
+## [0.1.0] - 2020-07-08
+### Added
+- Add CHANGELOG.md
+
+### Changed
+- Align documentation to latest structure and style
+
+## [0.0.4] - 2020-06-18
+### Added
+- Add a unit tests
+
+### Changed
+- Align repository to latest structure and style
+
+## [0.0.3] - 2020-06-18
+### Fixed
+- Fix creation of empty group resources
+
+## [0.0.2] - 2020-05-25
+### Added
+- Add support for adding multiple users at once
+
+## [0.0.1] - 2020-05-25
+### Added
+- Add IAM user support
+- Add IAM user inline policy support
+- Add custom or managed policies support
+- Add support to attach the user to a list of groups by group name
+
+<!-- markdown-link-check-disable -->
+[Unreleased]: https://github.com/mineiros-io/terraform-aws-iam-user/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/mineiros-io/terraform-aws-iam-user/compare/v0.0.4...v0.1.0
+<!-- markdown-link-check-disabled -->
+[0.0.4]: https://github.com/mineiros-io/terraform-aws-iam-user/compare/v0.0.3...v0.0.4
+[0.0.3]: https://github.com/mineiros-io/terraform-aws-iam-user/compare/v0.0.2...v0.0.3
+[0.0.2]: https://github.com/mineiros-io/terraform-aws-iam-user/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/mineiros-io/terraform-aws-iam-user/releases/tag/v0.0.1
diff --git a/Makefile b/Makefile
@@ -46,13 +46,19 @@ DOCKER_RUN_CMD  = docker run ${DOCKER_FLAGS} ${BUILD_TOOLS_DOCKER_IMAGE}
 .PHONY: default
 default: help
 
-## Run pre-commit hooks in build-tools docker container.
+# Not exposed as a callable target by `make help`, since this is a one-time shot to simplify the development of this module.
+.PHONY: template/adjust
+template/adjust: FILTER = -path ./.git -prune -a -type f -o -type f -not -name Makefile
+template/adjust:
+	@find . $(FILTER) -exec sed -i -e "s,terraform-module-template,$${PWD##*/},g" {} \;
+
+## Run pre-commit hooks inside a build-tools docker container.
 .PHONY: test/pre-commit
 test/pre-commit: DOCKER_FLAGS += ${DOCKER_SSH_FLAGS}
 test/pre-commit:
 	$(call docker-run,pre-commit run -a)
 
-## Run go tests hooks in build-tools docker container.
+## Run all Go tests inside a build-tools docker container. This is complementary to running 'go test ./test/...'.
 .PHONY: test/unit-tests
 test/unit-tests: DOCKER_FLAGS += ${DOCKER_SSH_FLAGS}
 test/unit-tests: DOCKER_FLAGS += ${DOCKER_AWS_FLAGS}
@@ -65,8 +71,8 @@ test/unit-tests:
 clean:
 	$(call rm-command,.terraform)
 	$(call rm-command,*.tfplan)
-	$(call rm-command,examples/*/.terraform)
-	$(call rm-command,examples/*/*.tfplan)
+	$(call rm-command,*/*/.terraform)
+	$(call rm-command,*/*/*.tfplan)
 
 ## Display help for all targets
 .PHONY: help

diff --git a/README.md b/README.md
@@ -52,7 +52,8 @@ Most basic usage showing how to add three users and assigning two policies:
 
 ```hcl
 module "iam-users" {
-  source  = "git@github.com:mineiros-io/terraform-aws-iam-user.git?ref=v0.0.3"
+  source  = "mineiros-io/iam-user/aws"
+  version = "~> 0.1.0"
 
   names = [
     "user.one",
@@ -238,10 +239,8 @@ Copyright &copy; 2020 [Mineiros GmbH][homepage]
 [badge-terraform]: https://img.shields.io/badge/terraform-0.13%20and%200.12.20+-623CE4.svg?logo=terraform
 [badge-slack]: https://img.shields.io/badge/slack-@mineiros--community-f32752.svg?logo=slack
 
-<!-- markdown-link-check-disable -->
 [build-status]: https://mineiros.semaphoreci.com/projects/terraform-aws-iam-user
 [releases-github]: https://github.com/mineiros-io/terraform-aws-iam-user/releases
-<!-- markdown-link-check-enable -->
 [releases-terraform]: https://github.com/hashicorp/terraform/releases
 [apache20]: https://opensource.org/licenses/Apache-2.0
 [slack]: https://join.slack.com/t/mineiros-community/shared_invite/zt-ehidestg-aLGoIENLVs6tvwJ11w9WGg
@@ -251,7 +250,6 @@ Copyright &copy; 2020 [Mineiros GmbH][homepage]
 [IAM-User-Docs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html
 [Semantic Versioning (SemVer)]: https://semver.org/
 
-<!-- markdown-link-check-disable -->
 [examples/example/main.tf]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/examples/example/main.tf
 [variables.tf]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/variables.tf
 [examples/]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/examples
@@ -260,4 +258,3 @@ Copyright &copy; 2020 [Mineiros GmbH][homepage]
 [Makefile]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/Makefile
 [Pull Requests]: https://github.com/mineiros-io/terraform-aws-iam-user/pulls
 [Contribution Guidelines]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/CONTRIBUTING.md
-<!-- markdown-link-check-enable -->
diff --git a/examples/README.md b/examples/README.md
@@ -10,9 +10,8 @@
 - [simple-users/] Create IAM Users with two Policy ARNs attached.
 
 <!-- References -->
-<!-- markdown-link-check-disable -->
-[example/]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/examples/example
-<!-- markdown-link-check-enable -->
+[require-mfa-credentials/]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/examples/require-mfa-credentials
+[simple-users/]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/examples/simple-users
 
 [homepage]: https://mineiros.io/?ref=terraform-aws-iam-user
 
@@ -21,9 +20,7 @@
 [badge-slack]: https://img.shields.io/badge/slack-@mineiros--community-f32752.svg?logo=slack
 [badge-semver]: https://img.shields.io/github/v/tag/mineiros-io/terraform-aws-iam-user.svg?label=latest&sort=semver
 
-<!-- markdown-link-check-disable -->
 [releases-github]: https://github.com/mineiros-io/terraform-aws-iam-user/releases
-<!-- markdown-link-check-enable -->
 [releases-terraform]: https://github.com/hashicorp/terraform/releases
 [apache20]: https://opensource.org/licenses/Apache-2.0
 [slack]: https://join.slack.com/t/mineiros-community/shared_invite/zt-ehidestg-aLGoIENLVs6tvwJ11w9WGg
diff --git a/examples/require-mfa-credentials/README.md b/examples/require-mfa-credentials/README.md
@@ -14,7 +14,8 @@ The `AllowManageOwnGitCredentials`, `AllowManageOwnSSHPublicKeys` and `AllowMana
 
 ```hcl
 module "iam-users" {
-  source = "git@github.com:mineiros-io/terraform-aws-iam-user.git?ref=v0.0.3"
+  source  = "mineiros-io/iam-user/aws"
+  version = "~> 0.1.0"
 
   names = [
     "user.one",
@@ -141,7 +142,5 @@ Run `terraform destroy -refresh=false -auto-approve` to destroy all previously c
 [apache20]: https://opensource.org/licenses/Apache-2.0
 [slack]: https://join.slack.com/t/mineiros-community/shared_invite/zt-ehidestg-aLGoIENLVs6tvwJ11w9WGg
 
-<!-- markdown-link-check-disable -->
 [main.tf]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/examples/require-mfa-credentials/main.tf
-<!-- markdown-link-check-enable -->
 [AWS documentation example]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_examples_aws_my-sec-creds-self-manage.html
diff --git a/examples/require-mfa-credentials/main.tf b/examples/require-mfa-credentials/main.tf
@@ -15,7 +15,8 @@ provider "aws" {
 # ------------------------------------------------------------------------------
 
 module "iam-users" {
-  source = "git@github.com:mineiros-io/terraform-aws-iam-user.git?ref=v0.0.3"
+  source  = "mineiros-io/iam-user/aws"
+  version = "~> 0.1.0"
 
   names = [
     "user.one",

diff --git a/examples/simple-users/README.md b/examples/simple-users/README.md
@@ -12,7 +12,8 @@ The code in [main.tf] defines an example for creating three users and attaching
 
 ```hcl
 module "iam-users" {
-  source = "git@github.com:mineiros-io/terraform-aws-iam-user.git?ref=v0.0.3"
+  source  = "mineiros-io/iam-user/aws"
+  version = "~> 0.1.0"
 
   names = [
     "user.one",
@@ -181,6 +182,4 @@ Run `terraform destroy -refresh=false -auto-approve` to destroy all previously c
 [apache20]: https://opensource.org/licenses/Apache-2.0
 [slack]: https://join.slack.com/t/mineiros-community/shared_invite/zt-ehidestg-aLGoIENLVs6tvwJ11w9WGg
 
-<!-- markdown-link-check-disable -->
 [main.tf]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/examples/simple-users/main.tf
-<!-- markdown-link-check-enable -->
diff --git a/examples/simple-users/main.tf b/examples/simple-users/main.tf
@@ -15,7 +15,8 @@ provider "aws" {
 # ------------------------------------------------------------------------------
 
 module "iam-users" {
-  source = "git@github.com:mineiros-io/terraform-aws-iam-user.git?ref=v0.0.3"
+  source  = "mineiros-io/iam-user/aws"
+  version = "~> 0.1.0"
 
   names = [
     "user.one",

diff --git a/test/README.md b/test/README.md
@@ -62,10 +62,8 @@ Alternatively, you can also run the tests without Docker.
 
 <!-- References -->
 
-<!-- markdown-link-check-disable -->
 [Makefile]: https://github.com/mineiros-io/terraform-aws-iam-user/blob/master/Makefile
 [Testdirectory]: https://github.com/mineiros-io/terraform-aws-iam-user/tree/master/test
-<!-- markdown-link-check-enable -->
 
 [homepage]: https://mineiros.io/?ref=terraform-aws-iam-user
 [Terratest]: https://github.com/gruntwork-io/terratest