Skip to content

Prepare minor release #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 8, 2020
Merged

Prepare minor release #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7889ec5
Update Makefile
mariux Jul 8, 2020
36eebfb
Add CHANGELOG.md
mariux Jul 8, 2020
98819d1
Prepare for new minor release
mariux Jul 8, 2020
4f91853
Fix example reference in index README
mariux Jul 8, 2020
36f8f8d
Remove markdown link checker safeguards
mariux Jul 8, 2020
daffb81
Fix template/adjust target in Makefile
mariux Jul 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
14 changes: 10 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbH, after seeing this a couple of times and thinking about it. This should rather be a separate cool or simple alias in your local bashrc rather than part of the repo

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually this should be a pre-commit to verify template cleanup has been done... like e.g. terraform fmt...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, so what are the next steps here? Shall we put this to our backlog?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not a priority at all.. let's see how often this process fails...

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}
Expand All @@ -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
Expand Down
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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 -->
7 changes: 2 additions & 5 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
5 changes: 2 additions & 3 deletions examples/require-mfa-credentials/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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
3 changes: 2 additions & 1 deletion examples/require-mfa-credentials/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
5 changes: 2 additions & 3 deletions examples/simple-users/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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 -->
3 changes: 2 additions & 1 deletion examples/simple-users/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 0 additions & 2 deletions test/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down