tidy up to release (#65)

brandonjbjelland · web-flow · commit 6746006ef8fa · 2018-05-05T01:07:44.000-07:00
* admin docs added to the repo
* `fmt` used to clean up `outputs.tf`
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,21 @@
+# I have issues
+
+## I'm submitting a
+
+* [ ] bug report
+* [ ] feature request
+* [ ] support request
+
+## What is the current behavior
+
+## If this is a bug, how to reproduce? Please include a code sample
+
+## What's the expected behavior
+
+## Environment
+
+* Affected module version:
+* OS:
+* Terraform version:
+
+## Other relevant info
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+# PR o'clock
+
+## Description
+
+Please explain the changes you made here and link to any relevant issues.
+
+### Checklist
+
+* [ ] `terraform fmt` and `terraform validate` both work from the root and `examples/alb_test_fixture` directories (look in CI for an example)
+* [ ] Tests for the changes have been added and passing (for bug fixes/features)
+* [ ] Test results are pasted in this PR (in lieu of CI)
+* [ ] Docs have been added/updated (for bug fixes/features)
+* [ ] Any breaking changes are noted in the description above
diff --git a/.travis.yml b/.travis.yml
@@ -1,55 +1,56 @@
 language: ruby
-sudo: false
+sudo: required
 dist: trusty
+services:
+- docker
 rvm:
-  - 2.4.2
-
+- 2.4.2
 before_install:
-  - echo "before_install"
-
+- echo "before_install"
 install:
-  - echo "install"
-  - gem install bundler --no-rdoc --no-ri
-  - bundle install
-
+- echo "install"
+- gem install bundler --no-rdoc --no-ri
+- bundle install
 before_script:
-  - echo 'before_script'
-  # Get a random region from the awscli and use it through the remainder of the test cycle.
-  - export AWS_REGION=$(docker run --env AWS_DEFAULT_REGION=us-east-2 --env AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY} --env AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} garland/aws-cli-docker aws ec2 describe-regions --query 'Regions[].{Name:RegionName}' --output text | shuf | head -n1)
-  - export TF_VAR_region=${AWS_REGION}
-  - export TF_WARN_OUTPUT_ERRORS=1
-  - echo "using AWS_REGION=${AWS_REGION}"
-  - curl --silent --output terraform.zip https://releases.hashicorp.com/terraform/0.11.5/terraform_0.11.5_linux_amd64.zip
-  - sha256sum terraform.zip  | grep "131c440263382c79c7f783b70ff35cd1d03eb31c44f7738d153d95a0b8436ac9" -q
-  - unzip terraform.zip ; rm -f terraform.zip; chmod +x terraform
-  - mkdir -p ${HOME}/bin ; export PATH=${PATH}:${HOME}/bin; mv terraform ${HOME}/bin/
-  - terraform -v
-
+- echo 'before_script'
+- export AWS_REGION=$(docker run --env AWS_DEFAULT_REGION=us-east-2 --env AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}
+  --env AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} garland/aws-cli-docker aws ec2 describe-regions
+  --query 'Regions[].{Name:RegionName}' --output text | shuf | head -n1)
+- export TF_VAR_region=${AWS_REGION}
+- export TF_WARN_OUTPUT_ERRORS=1
+- echo "using AWS_REGION=${AWS_REGION}"
+- curl --silent --output terraform.zip https://releases.hashicorp.com/terraform/0.11.7/terraform_0.11.7_linux_amd64.zip
+- sha256sum terraform.zip  | grep "6b8ce67647a59b2a3f70199c304abca0ddec0e49fd060944c26f666298e23418"
+  -q
+- unzip terraform.zip ; rm -f terraform.zip; chmod +x terraform
+- mkdir -p ${HOME}/bin ; export PATH=${PATH}:${HOME}/bin; mv terraform ${HOME}/bin/
+- terraform -v
 script:
-  - echo 'script'
-  -
-  - terraform init
-  - terraform fmt -check=true
-  - terraform validate -var "region=${AWS_REGION}" -var "subnets=[]" -var "vpc_id=vpc-abcde012" -var "load_balancer_name=my-lb" -var "log_bucket_name=my-log-bucket" -var "security_groups=[]"
-  - docker run --rm -v $(pwd):/app/ --workdir=/app/ -t wata727/tflint --error-with-issues
-  - cd examples/alb_test_fixture
-  - terraform init
-  - terraform fmt -check=true
-  - terraform validate
-  - cd -
-  - terraform -v
-  - bundle exec kitchen test --destroy always
-
+- echo 'script'
+- terraform init
+- terraform fmt -check=true
+- terraform validate -var "region=${AWS_REGION}" -var "subnets=[]" -var "vpc_id=vpc-abcde012"
+  -var "load_balancer_name=my-lb" -var "log_bucket_name=my-log-bucket" -var "security_groups=[]"
+- docker run --rm -v $(pwd):/app/ --workdir=/app/ -t wata727/tflint --error-with-issues
+- cd examples/alb_test_fixture
+- terraform init
+- terraform fmt -check=true
+- terraform validate
+- cd -
+- terraform -v
+- bundle exec kitchen test --destroy always
 deploy:
-# publish to the registry when those APIs are documented
   provider: script
   script: ci/deploy.sh
   on:
     branch: master
-
 notifications:
   email:
     recipients:
-      - brandon@atscale.run
+    - brandon@atscale.run
     on_success: change
     on_failure: change
+secret:
+  secure: PVcAmalsUV5cKSU1jVG51nfJaOoy6s9f6ZK7mZlhnl+gNlYumu+e+KURSNS7zAdgdlEJwGwvnOvSuKdWDhR+dRuSmMQT47NwtMMDsWOWUTQff9Dzj1+vcuhwd5tHltjL+WpKWM/t69Ka5nMzmcj2GjMjmGl084dWIZkqGp3AV3MNKIBO4Pv+kLI9iP195FppBgET7kO2EYKTFslyBkXUW4vZvLtICIOhOKUJae6c9QA/gXnKaZSSs42LuEstBtBBnTObLM+MzheT3mQHRG5eARo1JuoGIkgA5yetP6XFrIM6tUuawGkbXDyB0J5Vsi7V9FYKXCy9uUuuUTbOr7JjxvT+NnB0ujWZe+0/7j3aHRhTUD1tt3zjXOMSM3WP8Y+2OkKWCf685vmlHXRfWBmzB6Fi9HAh1P5JnBx7eDIhvelNRjxuqmETX68UIexU0jT8ft3jbm0ctgDIf2rAGM6SLx712lq5YPJVkBPj+W3BrSZVMTI232+i4Ic6vHyF4m1/ZHAEdpJyDQT2f84OEkENEZkzHURmlsm0kIzq+DJ5k5NrXEUjaGdYQKpQsdyJhpAGzVLS5jjDHv6RC3o9v4q9jVq7lf4ppZY3kypz3ZuOem25kkCZbhIwkUtN3ocA3YRvLTMJ07MXc7lRvcZSC1v9Rwd9/tJNwqTiGwRW4atNkUk=
+id:
+  secure: B8lds7kkeef9kAkynrLM7+Em61IUdVUWpr0UdRtSEgp5O0KdvBmE3SVuBiz4wMMVbyhwcMUwPda8kWDbUi+qcPZbMpNnkq900QXrBfbQjynKFR5clO3mAuvl8tlAR2zdg4w/MlBCXrrxceCpcLl0WQ/CgxnVO/+rGZGlsW63jVYfvJFEucdJdHmYTHfmTclHG4/kWn/P9ODTbf2TPrCUIlyJTR00ev6kNBmnEj8mDa5yy8LS/8l511ybBBA6W1w7u7hPOJXTpOVY84SnqcHzYkwyYmjUsQ+n9IcESxsJjzviz1Z5c/raRQox8zYG/utcIXpM6rm5QYtDrH6Ud4Gq/vpz3a4O9RqncJEWKQLaqeG5945MCf6qlC82tF/8Fj78oZOhiLEeG2I7nSHWOZ9ylcmtCJSVjJ4agAwZ8k6Vw2t4l/DAkIb0ATaYpzcnn0xA5YAjMHqK8HSRM9KWKdL6fz2/5AdN5raFhPNibwvdf4RnTIduJSlFILKBihRzlloGtSud4r1Zo+CIVYodqlkmYwC+6iV5hcktnVEsfrWg2gA0l5EymWh62T4pgBqM/kjDOqEOHukuWvNZwljjnXthjwR2PYw1qAFLtXULWJPyfEnpL0OW1CH1t22olhpuWgV4X50SdUaT3Z1HdnPLuVJ1ew97w6g6AX0u/4GDAyqwQ2c=
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this
 project adheres to [Semantic Versioning](http://semver.org/).
 
+## [[v3.3.0](https://github.com/terraform-aws-modules/terraform-aws-alb/compare/v3.2.0...v3.3.0)] - 2018-05-04]
+
+### Added
+
+* `target_group_arn_suffixes` added to support monitoring through CloudWatch (props, @jeff-everett 🤗)
+* Contributor Covenant gives guidelines on contributions.
+* Issues and PR templates.
+
 ## [v3.2.0] - 2018-03-28
 
 ### Changed
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,85 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1.  Ensure any install or build dependencies are removed before the end of the layer when doing a build.
+2.  Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
+3.  Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4.  You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at team@atscale.run. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/Gemfile b/Gemfile
@@ -4,6 +4,6 @@ ruby '2.4.2'
 
 source 'https://rubygems.org/' do
   gem 'awspec', '~> 1.4.2'
-  gem 'kitchen-terraform', '~> 3.2'
+  gem 'kitchen-terraform', '~> 3.3'
   gem 'kitchen-verifier-awspec', '~> 0.1.1'
 end
diff --git a/README.md b/README.md
@@ -3,8 +3,8 @@
 A Terraform module containing common configurations for an AWS Application Load
 Balancer (ALB) running over HTTP/HTTPS. Available through the [terraform registry](https://registry.terraform.io/modules/terraform-aws-modules/alb/aws).
 
-| Branch | Build status |
-| --- | --- |
+| Branch | Build status                                                                                                                                                      |
+| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | master | [![build Status](https://travis-ci.org/terraform-aws-modules/terraform-aws-alb.svg?branch=master)](https://travis-ci.org/terraform-aws-modules/terraform-aws-alb) |
 
 ## Assumptions
@@ -34,8 +34,8 @@ to the ASG immediately or will result in failure. The value of `target_group[n][
 The use-case presented here appears almost identical to how one would use an ELB
 but we inherit a few bonuses by moving to ALB like the ability to leverage WAF.
 [AWS's documentation](https://aws.amazon.com/elasticloadbalancing/applicationloadbalancer/) has a more
-exhastive set of reasons. Alternatively, if using ALB with ECS look no further than
-the [hashicorp example](https://github.com/terraform-providers/terraform-provider-aws/blob/master/examples/ecs-alb).
+exhaustive set of reasons. Alternatively, if using ALB with ECS look no further than
+the [Hashicorp example](https://github.com/terraform-providers/terraform-provider-aws/blob/master/examples/ecs-alb).
 
 ## Resources, inputs, outputs
 
@@ -68,28 +68,21 @@ module "alb" {
 
 This module has been packaged with [awspec](https://github.com/k1LoW/awspec) tests through [kitchen](https://kitchen.ci/) and [kitchen-terraform](https://newcontext-oss.github.io/kitchen-terraform/). To run them:
 
-1. Install [rvm](https://rvm.io/rvm/install) and the ruby version specified in the [Gemfile](https://github.com/terraform-aws-modules/terraform-aws-alb/tree/master/Gemfile).
-2. Install bundler and the gems from our Gemfile:
+1.  Install [rvm](https://rvm.io/rvm/install) and the ruby version specified in the [Gemfile](https://github.com/terraform-aws-modules/terraform-aws-alb/tree/master/Gemfile).
+2.  Install bundler and the gems from our Gemfile:
 
     ```bash
     gem install bundler && bundle install
     ```
 
-3. Ensure your AWS environment is configured (i.e. credentials and region) for test and set TF_VAR_region to a valid AWS region (e.g. `export TF_VAR_region=${AWS_REGION}`).
-4. Test using `bundle exec kitchen test` from the root of the repo.
+3.  Ensure your AWS environment is configured (i.e. credentials and region) for test and set TF_VAR_region to a valid AWS region (e.g. `export TF_VAR_region=${AWS_REGION}`).
+4.  Test using `bundle exec kitchen test` from the root of the repo.
 
 ## Contributing
 
-Report issues/questions/feature requests on in the [Issues](https://github.com/terraform-aws-modules/terraform-aws-alb/issues) section.
+Report issues/questions/feature requests on in the [issues](https://github.com/terraform-aws-modules/terraform-aws-alb/issues/new) section.
 
-Pull requests are welcome! Ideally create a feature branch and issue for every
-individual change made. These are the steps:
-
-1. Fork the repo to a personal space or org.
-2. Create your feature branch from master (`git checkout -b my-new-feature`).
-3. Commit your awesome changes (`git commit -am 'Added some feature'`).
-4. Push to the branch (`git push origin my-new-feature`).
-5. Create a new Pull Request and tell us about your changes.
+Full contributing [guidelines are covered here](https://github.com/terraform-aws-modules/terraform-aws-alb/blob/master/CONTRIBUTING.md).
 
 ## IAM Permissions
 
@@ -103,7 +96,7 @@ The [changelog](https://github.com/terraform-aws-modules/terraform-aws-alb/tree/
 ## Authors
 
 Created and maintained by [Brandon O'Connor](https://github.com/brandoconnor) - brandon@atscale.run.
-Many thanks to [the contributers listed here](https://github.com/terraform-aws-modules/terraform-aws-alb/graphs/contributors)!
+Many thanks to [the contributors listed here](https://github.com/terraform-aws-modules/terraform-aws-alb/graphs/contributors)!
 
 ## License
 
diff --git a/examples/alb_test_fixture/main.tf b/examples/alb_test_fixture/main.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = "= 0.11.5"
+  required_version = "= 0.11.7"
 }
 
 provider "aws" {
diff --git a/outputs.tf b/outputs.tf
@@ -44,9 +44,9 @@ output "target_group_arns" {
 }
 
 output "target_group_arn_suffixes" {
-    description = "ARN suffixes of our target groups - can be used with CloudWatch."
-    value       = "${slice(concat(aws_lb_target_group.main.*.arn_suffix, list("")), 0, var.target_groups_count)}"
-  }
+  description = "ARN suffixes of our target groups - can be used with CloudWatch."
+  value       = "${slice(concat(aws_lb_target_group.main.*.arn_suffix, list("")), 0, var.target_groups_count)}"
+}
 
 output "target_group_names" {
   description = "Name of the target group. Useful for passing to your CodeDeploy Deployment Group."
diff --git a/version b/version
@@ -1 +1 @@
-v3.2.0
+v3.3.0

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`terraform {`
`2`		`- required_version = "= 0.11.5"`
	`2`	`+ required_version = "= 0.11.7"`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`provider "aws" {`