Merge pull request #6 from tomarv2/develop

Pulling refs/heads/develop into main

Author: tomarv2

.github/workflows/pre-commit.yml

@@ -4,11 +4,10 @@ on:
   pull_request:
   push:
     branches:
-      - main
       - develop
+      - main
 
 jobs:
-# Min Terraform version(s)
   getDirectories:
     name: Get root directories
     runs-on: ubuntu-latest
@@ -25,13 +24,13 @@ jobs:
       - name: Build matrix
         id: matrix
         run: |
-          DIRS=$(python -c "import json; import glob; print(json.dumps([x.replace('/versions.tf', '') for x in glob.glob('./**/versions.tf', recursive=True)]))")
+          DIRS=$(python -c "import json; import glob; print(json.dumps([x.replace('/providers.tf', '') for x in glob.glob('./**/providers.tf', recursive=True)]))")
           echo "::set-output name=directories::$DIRS"
     outputs:
       directories: ${{ steps.matrix.outputs.directories }}
 
   preCommitMinVersions:
-    name: Min TF validate
+    name: Min validate
     needs: getDirectories
     runs-on: ubuntu-latest
     strategy:
@@ -58,11 +57,9 @@ jobs:
         with:
           terraform_version: ${{ steps.minMax.outputs.minVersion }}
 
-      - name: Install pre-commit dependencies
+      - name: Install pre-commit
         run: pip install pre-commit
 
-
-# Max Terraform version
   getBaseVersion:
     name: Module max TF version
     runs-on: ubuntu-latest
@@ -78,7 +75,7 @@ jobs:
       maxVersion: ${{ steps.minMax.outputs.maxVersion }}
 
   preCommitMaxVersion:
-    name: Max TF pre-commit
+    name: Max pre-commit
     runs-on: ubuntu-latest
     needs: getBaseVersion
     strategy:
@@ -105,10 +102,59 @@ jobs:
         run: |
           pip install pre-commit
           pip install checkov
-          curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-v1.0.1-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
           curl -L "$(curl -s https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip")" > tflint.zip && unzip tflint.zip && rm tflint.zip && sudo mv tflint /usr/bin/
 
       - name: Execute pre-commit
-        # Run all pre-commit checks on max version supported
-        if: ${{ matrix.version ==  needs.getBaseVersion.outputs.maxVersion }}
-        run: pre-commit run --color=always --show-diff-on-failure --all-files
+        continue-on-error: true # To avoid pre-commit failure
+        run: |
+          pre-commit run --color=always --show-diff-on-failure --all-files
+
+      - name: Get current branch name
+        id: vars
+        run: |
+          echo ::set-output name=branch_name::${GITHUB_REF##*/}
+
+      - name: "Get branch name and save to env"
+        env:
+          IS_PR: ${{ github.EVENT_NAME == 'pull_request' }}
+        run: |
+          if ${IS_PR}; then
+            BRANCH_NAME="${GITHUB_HEAD_REF}"
+          else
+            BRANCH_NAME="${GITHUB_REF##*/}"
+          fi
+          echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_ENV
+
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Render terraform docs and commit changes
+        if: ${{ env.BRANCH_NAME }}  == 'develop'
+        uses: terraform-docs/gh-actions@main
+        with:
+          working-dir: .
+          output-file: README.md
+          output-method: inject
+          git-push: "true"
+
+      - name: Commit pre-commit modified files
+        if: ${{ env.BRANCH_NAME }} == 'develop'
+        run: |
+          git config --local user.email "terraform+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git diff-index --quiet HEAD || (git add -A && git commit -m'[bot] update files' --allow-empty && git push -f)
+
+      - uses: actions/checkout@v2
+      - name: Create PR
+        continue-on-error: true
+        uses: repo-sync/pull-request@v2
+        if: ${{ env.BRANCH_NAME }}  == 'develop'
+        with:
+          source_branch: "develop"
+          destination_branch: "main"
+          pr_title: "Pulling ${{ github.ref }} into main"
+          pr_body: ":crown: *Automated PR*"
+          pr_label: "auto-pr"
+          pr_allow_empty: false
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/state-actions.yml

@@ -0,0 +1,32 @@
+name: "Mark or close stale issues and PRs"
+on:
+  schedule:
+  - cron: "0 0 10 * *"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/stale@v4
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        # Staling issues and PR's
+        days-before-stale: 30
+        stale-issue-label: stale
+        stale-pr-label: stale
+        stale-issue-message: |
+          This issue has been automatically marked as stale because it has been open 30 days
+          with no activity. Remove stale label or comment or this issue will be closed in 10 days
+        stale-pr-message: |
+          This PR has been automatically marked as stale because it has been open 30 days
+          with no activity. Remove stale label or comment or this PR will be closed in 10 days
+        # Not stale if have this labels or part of milestone
+        exempt-issue-labels: bug,wip,on-hold
+        exempt-pr-labels:    bug,wip,on-hold
+        exempt-all-milestones: true
+        # Close issue operations
+        # Label will be automatically removed if the issues are no longer closed nor locked.
+        days-before-close: 10
+        delete-branch: false
+        close-issue-message: This issue was automatically closed because of stale in 10 days
+        close-pr-message: This PR was automatically closed because of stale in 10 days

.gitignore

@@ -29,6 +29,7 @@ override.tf.json
 # example: *tfplan*
 
 .idea/
+.vscode/
 .terraform.lock.hcl
 
 # go
@@ -81,15 +82,10 @@ _testmain.go
 
 # Python
 # Editors
-.vscode/
-.idea/
 
 # Vagrant
 .vagrant/
 
-# Mac/OSX
-.DS_Store
-
 # Windows
 Thumbs.db
 
@@ -99,9 +95,6 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
 # Distribution / packaging
 .Python
 build/
@@ -206,9 +199,14 @@ venv.bak/
 .dmypy.json
 dmypy.json
 
-# ignore test related file(s)
-**/test**
-**.
-
-# ignore terraform external modules
+# Terraform external modules
 **/.external_modules
+
+# Test files and directories
+**/[Tt]est/*
+**/[Tt]ests/*
+**/*[Tt]est*/*
+**/*[Tt]ests*/*
+
+# remote_backend.tf file
+**/remote_backend.tf

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
-  - repo: git://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.60.0
+  - repo: https://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.64.0
     hooks:
       - id: terraform_fmt
       - id: terraform_tflint
@@ -12,7 +12,7 @@ repos:
           - '--args=--only=terraform_documented_outputs'
           - '--args=--only=terraform_documented_variables'
           - '--args=--only=terraform_typed_variables'
-          - '--args=--only=terraform_module_pinned_source'
+          #- '--args=--only=terraform_module_pinned_source'
           - '--args=--only=terraform_naming_convention'
           - '--args=--only=terraform_required_providers'
           - '--args=--only=terraform_standard_module_structure'

README.md

@@ -13,20 +13,20 @@
         <img src="https://img.shields.io/twitter/follow/varuntomar2019?style=social&logo=twitter"></a>
 </p>
 
-# Terraform module for [AWS CloudWatch Events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html)
+## Terraform module for [AWS CloudWatch Events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html)
 
-## Versions
+### Versions
 
 - Module tested for Terraform 1.0.1.
-- AWS provider version [3.63](https://registry.terraform.io/providers/hashicorp/aws/latest)
+- AWS provider version [3.74](https://registry.terraform.io/providers/hashicorp/aws/latest)
 - `main` branch: Provider versions not pinned to keep up with Terraform releases.
 - `tags` releases: Tags are pinned with versions (use <a href="https://github.com/tomarv2/terraform-aws-cloudwatch-events/tags" alt="GitHub tag">
         <img src="https://img.shields.io/github/v/tag/tomarv2/terraform-aws-cloudwatch-events" /></a>).
 
 
-## Usage
+### Usage
 
-### Option 1:
+#### Option 1:
 
 ```
 terrafrom init
@@ -36,9 +36,9 @@ terraform destroy -var='teamid=tryme' -var='prjid=project1'
 ```
 **Note:** With this option please take care of remote state storage
 
-### Option 2:
+#### Option 2:
 
-#### Recommended method (stores remote state in S3 using `prjid` and `teamid` to create directory structure):
+##### Recommended method (stores remote state in S3 using `prjid` and `teamid` to create directory structure):
 
 - Create python 3.8+ virtual environment
 ```
@@ -84,23 +84,21 @@ tf -c=aws apply -var='teamid=foo' -var='prjid=bar'
 tf -c=aws destroy -var='teamid=foo' -var='prjid=bar'
 ```
 
-**NOTE:**
-
-- Read more on [tfremote](https://github.com/tomarv2/tfremote)
----
+**Note:** Read more on [tfremote](https://github.com/tomarv2/tfremote)
 
+<!-- BEGIN_TF_DOCS -->
 ## Requirements
 
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.1 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.63 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 3.74 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.63 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.74 |
 
 ## Modules
 
@@ -117,26 +115,24 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | aws region to deploy resources | `string` | `"us-west-2"` | no |
 | <a name="input_branch"></a> [branch](#input\_branch) | branch to use for cicd | `string` | `"main"` | no |
 | <a name="input_custom_input"></a> [custom\_input](#input\_custom\_input) | custom input to be included in generated events | `map(any)` | `null` | no |
 | <a name="input_deploy_event_rule"></a> [deploy\_event\_rule](#input\_deploy\_event\_rule) | Feature flag, true or false | `bool` | `true` | no |
 | <a name="input_deploy_event_target"></a> [deploy\_event\_target](#input\_deploy\_event\_target) | Feature flag, true or false | `bool` | `true` | no |
 | <a name="input_description"></a> [description](#input\_description) | description for the cloudwatch event | `string` | `null` | no |
 | <a name="input_name"></a> [name](#input\_name) | Cloudwatch event rule name | `string` | `null` | no |
 | <a name="input_prjid"></a> [prjid](#input\_prjid) | Name of the project/stack e.g: mystack, nifieks, demoaci. Should not be changed after running 'tf apply' | `string` | n/a | yes |
-| <a name="input_profile"></a> [profile\_to\_use](#input\_profile\_to\_use) | Getting values from ~/.aws/credentials | `string` | `"default"` | no |
 | <a name="input_schedule"></a> [schedule](#input\_schedule) | schedule for the cloudwatch event | `string` | `"rate(1 day)"` | no |
 | <a name="input_service_role"></a> [service\_role](#input\_service\_role) | service role to be used by cicd | `string` | `null` | no |
 | <a name="input_suffix"></a> [suffix](#input\_suffix) | suffix to be added to cloudwatch rule name | `string` | `"rule"` | no |
 | <a name="input_target_arn"></a> [target\_arn](#input\_target\_arn) | target arn | `string` | n/a | yes |
-| <a name="input_target_name"></a> [target\_name](#input\_target\_name) | Cloudwatch target name | `string` | `null` | no |
 | <a name="input_teamid"></a> [teamid](#input\_teamid) | Name of the team/group e.g. devops, dataengineering. Should not be changed after running 'tf apply' | `string` | n/a | yes |
 | <a name="input_timeout"></a> [timeout](#input\_timeout) | timeout for cloudwatch event | `number` | `60` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| <a name="output_cloudwatch_event_rule_arn"></a> [cloudwatch\_event\_rule\_arn](#output\_cloudwatch\_event\_rule\_arn) | The cloudwatch event rule arn. |
-| <a name="output_cloudwatch_event_target_arn"></a> [cloudwatch\_event\_target\_arn](#output\_cloudwatch\_event\_target\_arn) | The cloudwatch event target arn. |
+| <a name="output_cloudwatch_event_rule_arn"></a> [cloudwatch\_event\_rule\_arn](#output\_cloudwatch\_event\_rule\_arn) | The cloudwatch event rule ARN |
+| <a name="output_cloudwatch_event_target_arn"></a> [cloudwatch\_event\_target\_arn](#output\_cloudwatch\_event\_target\_arn) | The cloudwatch event target ARN |
+<!-- END_TF_DOCS -->

examples/main.tf

@@ -2,13 +2,13 @@ terraform {
   required_version = ">= 1.0.1"
   required_providers {
     aws = {
-      version = "~> 3.63"
+      version = "~> 3.74"
     }
   }
 }
 
 provider "aws" {
-  region = "us-west-2"
+  region = var.region
 }
 
 module "cloudwatch_event" {

examples/variables.tf

@@ -7,3 +7,9 @@ variable "prjid" {
   description = "Name of the project/stack e.g: mystack, nifieks, demoaci. Should not be changed after running 'tf apply'"
   type        = string
 }
+
+variable "region" {
+  description = "AWS region to create resources"
+  default     = "us-west-2"
+  type        = string
+}

main.tf

@@ -6,7 +6,7 @@ locals {
 resource "aws_cloudwatch_event_rule" "event_rule" {
   count = var.deploy_event_rule ? 1 : 0
 
-  name                = var.name != null ? var.name : "${var.teamid}-${var.prjid}"
+  name                = var.name != null ? "${var.name}-${var.suffix}" : "${var.teamid}-${var.prjid}-${var.suffix}"
   description         = var.description == null ? "Terraform managed: ${var.teamid}-${var.prjid}" : var.description
   schedule_expression = var.schedule
   role_arn            = var.service_role

outputs.tf

@@ -1,9 +1,9 @@
 output "cloudwatch_event_rule_arn" {
-  description = "The cloudwatch event rule arn."
+  description = "The cloudwatch event rule ARN"
   value       = join("", aws_cloudwatch_event_rule.event_rule.*.arn)
 }
 
 output "cloudwatch_event_target_arn" {
-  description = "The cloudwatch event target arn."
+  description = "The cloudwatch event target ARN"
   value       = join("", aws_cloudwatch_event_target.event_target_input_type.*.arn)
 }

versions.tf providers.tfversions.tf renamed to providers.tf

@@ -2,7 +2,7 @@ terraform {
   required_version = ">= 1.0.1"
   required_providers {
     aws = {
-      version = "~> 3.63"
+      version = "~> 3.74"
     }
   }
 }