Skip to content

Commit 12d974d

Browse files
Ic3w0lfIc3w0lf
authored
Merge pull request #3 from geekcell/update-templates
docs: update templates
2 parents ffeea0a + d5e5079 commit 12d974d

16 files changed

+151
-170
lines changed

‎.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ end_of_line = lf
88
indent_size = 2
99
indent_style = space
1010
insert_final_newline = true
11-
max_line_length = 80
11+
max_line_length = 120
1212
trim_trailing_whitespace = true
1313

1414
[*.md]

‎.github/.templatesyncignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
README.md
2+
.github/workflows/*
3+
.terraform-docs.yml
4+
docs/20-badges.md
5+
docs/assets/logo.svg
6+
*.tf
7+
test/*
8+
go.mod
9+
go.sum

‎.github/dependabot.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
##############################
3+
## Dependabot configuration ##
4+
##############################
5+
6+
#
7+
# Documentation:
8+
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates
9+
#
10+
11+
version: 2
12+
updates:
13+
# Maintain dependencies for GitHub Actions
14+
- package-ecosystem: "github-actions"
15+
directory: "/"
16+
schedule:
17+
interval: "daily"
18+
open-pull-requests-limit: 0
19+
20+
# Maintain dependencies for Terraform Providers
21+
- package-ecosystem: "terraform"
22+
directory: "/"
23+
schedule:
24+
interval: "daily"
25+
open-pull-requests-limit: 0
26+
27+
# Maintain dependencies for Golang
28+
- package-ecosystem: "gomod"
29+
directory: "/"
30+
schedule:
31+
interval: "daily"
32+
open-pull-requests-limit: 0

‎.github/labels.yaml

-34
This file was deleted.

‎.github/pull_request-template.md

-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55

66
...
77

8-
## How this PR fixes it
9-
10-
...
11-
128
## Readiness Checklist
139

1410
### Author/Contributor

‎.github/workflows/release.yaml

+25-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
####################################
3-
## Draft releases on Push to main ##
4-
####################################
2+
#####################
3+
## Create releases ##
4+
#####################
55

66
#
77
# Documentation:
@@ -13,9 +13,8 @@ on:
1313
push:
1414
branches: [ main ]
1515
tags: [ 'v*.*.*' ]
16-
17-
permissions:
18-
contents: write
16+
pull_request:
17+
types: [ labeled ]
1918

2019
#################
2120
# Start the job #
@@ -26,6 +25,7 @@ jobs:
2625
###############
2726
create-release:
2827
name: Create Release
28+
if: github.event.action != 'labeled'
2929
runs-on: ubuntu-latest
3030
timeout-minutes: 10
3131
steps:
@@ -75,3 +75,22 @@ jobs:
7575
tag_name: ${{ steps.tag.outputs.value }}
7676
draft: false
7777
prerelease: false
78+
79+
###########################
80+
# Release preview comment #
81+
###########################
82+
release-check:
83+
if: github.event.action == 'labeled'
84+
runs-on: ubuntu-latest
85+
steps:
86+
############################
87+
# Checkout the source code #
88+
############################
89+
- name: Checkout Code
90+
uses: actions/[email protected]
91+
92+
#######################
93+
# Post status comment #
94+
#######################
95+
- name: Post bumpr status comment
96+
uses: haya14busa/action-bumpr@v1

‎.github/workflows/sync-templates.yaml

+11-30
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010

1111
name: Sync templates
1212
on:
13-
workflow_dispatch:
13+
workflow_dispatch: # Trigger manually
14+
schedule:
15+
- cron: "0 0 1 * *" # Run at 00:00 on the first day of every month
1416

1517
##########################
1618
# Prevent duplicate jobs #
@@ -36,7 +38,7 @@ jobs:
3638
- name: Sync labels
3739
uses: EndBug/[email protected]
3840
with:
39-
config-file: https://raw.githubusercontent.com/geekcell/template-terraform-module/main/.github/labels.yaml
41+
config-file: https://gist.githubusercontent.com/Ic3w0lf/f5520c5f19d7098966f692c120f7a197/raw/75b134f76fbc55e2e64bd66f04e571d6d74b815e/terraform-aws-module-labels.yaml
4042

4143
#######################
4244
# Sync template files #
@@ -50,33 +52,12 @@ jobs:
5052
############################
5153
- name: Checkout Code
5254
uses: actions/[email protected]
53-
with:
54-
token: ${{ secrets.GEEKCELL_PAT_WORKFLOWS }}
55-
56-
########################
57-
# Patch template files #
58-
########################
59-
- name: Force patching of template files
60-
run: |
61-
yes y | make setup/update-template
62-
63-
####################
64-
# Update README.md #
65-
####################
66-
- name: Terraform docs
67-
uses: terraform-docs/[email protected]
68-
with:
69-
config-file: .terraform-docs.yml
70-
git-push: false
7155

72-
#############
73-
# Create PR #
74-
#############
75-
- name: Create PR
76-
uses: peter-evans/[email protected]
56+
#######################
57+
# Sync template files #
58+
#######################
59+
- name: actions-template-sync
60+
uses: AndreasAugustin/[email protected]
7761
with:
78-
token: ${{ secrets.GEEKCELL_PAT_WORKFLOWS }}
79-
title: Updated template files
80-
commit-message: Update template files from main repo
81-
branch: update-template-files
82-
delete-branch: true
62+
github_token: ${{ secrets.GITHUB_TOKEN }}
63+
source_repo_path: geekcell/terraform-aws-module-template

‎.pre-commit-config.yaml

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
repos:
22
- repo: https://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.76.0
3+
rev: v1.80.0
44
hooks:
55
- id: terraform_docs
66
- id: terraform_fmt
77
- id: terraform_validate
8+
args:
9+
- --hook-config=--retry-once-with-cleanup=true
810
exclude: '^[^/]+$'
911
- id: terraform_tflint
1012
exclude: ^examples/
1113

1214
- repo: https://github.com/pre-commit/pre-commit-hooks
13-
rev: v4.3.0
15+
rev: v4.4.0
1416
hooks:
1517
- id: trailing-whitespace
1618
- id: end-of-file-fixer

‎.terraform-docs.yml

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
formatter: "md table"
22
header-from: main.tf
33

4+
recursive:
5+
# Enable this if your module has submodules
6+
enabled: false
7+
48
content: |-
5-
{{ include "docs/logo.md" }}
9+
{{ include "docs/10-header.md" }}
610
7-
{{ include "docs/badges.md" }}
11+
{{ include "docs/20-badges.md" }}
812
913
{{ .Header }}
1014

‎README.md

+26-29
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- BEGIN_TF_DOCS -->
2-
[![Geek Cell GmbH](https://raw.githubusercontent.com/geekcell/template-terraform-module/main/docs/assets/logo.svg)](https://www.geekcell.io/)
2+
[![Geek Cell GmbH](https://raw.githubusercontent.com/geekcell/.github/main/geekcell-github-banner.png)](https://www.geekcell.io/)
33

44
### Code Quality
55
[![License](https://img.shields.io/github/license/geekcell/terraform-aws-waf)](https://github.com/geekcell/terraform-aws-waf/blob/master/LICENSE)
@@ -8,30 +8,35 @@
88
[![Validate](https://github.com/geekcell/terraform-aws-waf/actions/workflows/validate.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-waf/actions/workflows/validate.yaml)
99
[![Lint](https://github.com/geekcell/terraform-aws-waf/actions/workflows/linter.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-waf/actions/workflows/linter.yaml)
1010

11+
<!--
12+
Comment in if Bridgecrew is configured
13+
1114
### Security
12-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=INFRASTRUCTURE+SECURITY)
15+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=INFRASTRUCTURE+SECURITY)
1316
1417
#### Cloud
15-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/cis_aws)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=CIS+AWS+V1.2)
16-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/cis_aws_13)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=CIS+AWS+V1.3)
17-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/cis_azure)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=CIS+AZURE+V1.1)
18-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/cis_azure_13)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=CIS+AZURE+V1.3)
19-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/cis_gcp)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=CIS+GCP+V1.1)
18+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/cis_aws)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=CIS+AWS+V1.2)
19+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/cis_aws_13)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=CIS+AWS+V1.3)
20+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/cis_azure)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=CIS+AZURE+V1.1)
21+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/cis_azure_13)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=CIS+AZURE+V1.3)
22+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/cis_gcp)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=CIS+GCP+V1.1)
2023
2124
##### Container
22-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/cis_kubernetes_16)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=CIS+KUBERNETES+V1.6)
23-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/cis_eks_11)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=CIS+EKS+V1.1)
24-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/cis_gke_11)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=CIS+GKE+V1.1)
25-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/cis_kubernetes)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=CIS+KUBERNETES+V1.5)
25+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/cis_kubernetes_16)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=CIS+KUBERNETES+V1.6)
26+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/cis_eks_11)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=CIS+EKS+V1.1)
27+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/cis_gke_11)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=CIS+GKE+V1.1)
28+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/cis_kubernetes)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=CIS+KUBERNETES+V1.5)
2629
2730
#### Data protection
28-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/soc2)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=SOC2)
29-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/pci)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=PCI-DSS+V3.2)
30-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/pci_dss_v321)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=PCI-DSS+V3.2.1)
31-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/iso)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=ISO27001)
32-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/nist)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=NIST-800-53)
33-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/hipaa)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=HIPAA)
34-
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-waf/fedramp_moderate)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-waf&benchmark=FEDRAMP+%28MODERATE%29)
31+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/soc2)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=SOC2)
32+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/pci)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=PCI-DSS+V3.2)
33+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/pci_dss_v321)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=PCI-DSS+V3.2.1)
34+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/iso)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=ISO27001)
35+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/nist)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=NIST-800-53)
36+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/hipaa)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=HIPAA)
37+
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-security-group/fedramp_moderate)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-security-group&benchmark=FEDRAMP+%28MODERATE%29)
38+
39+
-->
3540

3641
# Terraform AWS WAF
3742

@@ -43,14 +48,6 @@ resources. With this Terraform module, you can easily and efficiently set
4348
up and manage AWS WAF for your Load Balancer, API Gateway, or Cognito
4449
User Pool.
4550

46-
Our team has extensive experience working with AWS WAF and has optimized
47-
this module to provide the best possible experience for users. The module
48-
encapsulates all necessary configurations, making it easy to use and
49-
integrate into your existing AWS environment. Whether you are just getting
50-
started with AWS WAF or looking for a more efficient way to manage your
51-
web application firewall, this Terraform module provides a preconfigured
52-
solution for protecting your web applications from common exploits.
53-
5451
## Inputs
5552

5653
| Name | Description | Type | Default | Required |
@@ -71,9 +68,9 @@ No outputs.
7168

7269
## Resources
7370

74-
- resource.aws_wafv2_ip_set.ip_blocking (main.tf#407)
75-
- resource.aws_wafv2_web_acl.main (main.tf#20)
76-
- resource.aws_wafv2_web_acl_association.main (main.tf#425)
71+
- resource.aws_wafv2_ip_set.ip_blocking (main.tf#399)
72+
- resource.aws_wafv2_web_acl.main (main.tf#12)
73+
- resource.aws_wafv2_web_acl_association.main (main.tf#417)
7774

7875
# Examples
7976
### Basic Example

‎docs/10-header.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[![Geek Cell GmbH](https://raw.githubusercontent.com/geekcell/.github/main/geekcell-github-banner.png)](https://www.geekcell.io/)

0 commit comments

Comments
 (0)