Skip to content

Commit 55338cd

Browse files
Ic3w0lfIc3w0lf
authored
Update template files (#11)
1 parent 8d42258 commit 55338cd

18 files changed

+135
-128
lines changed

‎.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

‎.github/workflows/test.yaml

+33-9
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,41 @@
1-
name: Test
1+
---
2+
###############
3+
## Run tests ##
4+
###############
5+
6+
#
7+
# Documentation:
8+
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
9+
#
210

11+
name: Test
312
on:
413
pull_request:
5-
workflow_dispatch:
614
push:
715
branches: [ main ]
816

9-
permissions:
10-
id-token: write
11-
contents: read
12-
17+
##########################
18+
# Prevent duplicate jobs #
19+
##########################
1320
concurrency:
1421
group: ${{ github.repository }}
1522
cancel-in-progress: false
1623

24+
permissions:
25+
id-token: write
26+
contents: read
27+
28+
###############
29+
# Run the job #
30+
###############
1731
jobs:
18-
test:
19-
name: Terraform Tests
32+
terratest:
33+
name: Terratest
2034
runs-on: ubuntu-latest
2135
steps:
36+
############################
37+
# Checkout the source code #
38+
############################
2239
- name: Checkout
2340
uses: actions/checkout@v3
2441

@@ -32,11 +49,18 @@ jobs:
3249
aws-region: ${{ vars.AWS_TESTING_REGION }}
3350
mask-aws-account-id: false
3451

52+
################
53+
# Setup Golang #
54+
################
3555
- name: Set up Go
3656
uses: actions/setup-go@v4
3757
with:
3858
go-version-file: 'go.mod'
3959

60+
#############
61+
# Run tests #
62+
#############
4063
- name: Run Tests
64+
timeout-minutes: 30
4165
working-directory: test
42-
run: go test -v -timeout 30m
66+
run: go test -v

‎.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

+8-21
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
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-security-group)](https://github.com/geekcell/terraform-aws-security-group/blob/master/LICENSE)
66
[![GitHub release (latest tag)](https://img.shields.io/github/v/release/geekcell/terraform-aws-security-group?logo=github&sort=semver)](https://github.com/geekcell/terraform-aws-security-group/releases)
77
[![Release](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/release.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/release.yaml)
88
[![Validate](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/validate.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/validate.yaml)
99
[![Lint](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/linter.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/linter.yaml)
10+
[![Test](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/test.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/test.yaml)
1011

1112
### Security
1213
[![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)
@@ -35,21 +36,7 @@
3536

3637
# Terraform AWS Security Group
3738

38-
Introducing the AWS Security Group Terraform Module, a simple and easy-to-use solution for creating and managing
39-
your security groups within Amazon Web Services (AWS). This module has been designed with ease of use in mind,
40-
providing you with a straightforward way to create and manage your security groups.
41-
42-
Our team of experts has years of experience working with AWS security groups and has a deep understanding of the
43-
best practices and configurations. By using this Terraform module, you can be sure that your security groups are
44-
created and managed in a secure and efficient manner.
45-
46-
This module offers a preconfigured solution for creating security groups and the ingress or egress rules that belong
47-
to them, saving you time and effort in the process. Whether you're looking to secure your resources or to limit the
48-
access to your applications, this module has you covered.
49-
50-
So, if you're looking for a convenient and reliable solution for creating and managing your security groups within
51-
AWS, look no further than the AWS Security Group Terraform Module. Give it a try and see how easy it is to create
52-
and manage your security groups!
39+
Terraform module to create a Security Group with ingress and egress rules in one go.
5340

5441
## Inputs
5542

@@ -74,13 +61,13 @@ and manage your security groups!
7461

7562
| Name | Version |
7663
|------|---------|
77-
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.36 |
64+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.36, < 5.0 |
7865

7966
## Resources
8067

81-
- resource.aws_security_group.main (main.tf#20)
82-
- resource.aws_security_group_rule.main_egress (main.tf#48)
83-
- resource.aws_security_group_rule.main_ingress (main.tf#32)
68+
- resource.aws_security_group.main (main.tf#6)
69+
- resource.aws_security_group_rule.main_egress (main.tf#34)
70+
- resource.aws_security_group_rule.main_ingress (main.tf#18)
8471

8572
# Examples
8673
### Full
@@ -94,7 +81,7 @@ module "vpc" {
9481
}
9582
9683
module "source_security_group" {
97-
source = "github.com/geekcell/terraform-aws-security-group?ref=main"
84+
source = "../../"
9885
9986
name = var.name
10087
vpc_id = module.vpc.vpc_id

‎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/)

‎docs/badges.md ‎docs/20-badges.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![Release](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/release.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/release.yaml)
55
[![Validate](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/validate.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/validate.yaml)
66
[![Lint](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/linter.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/linter.yaml)
7+
[![Test](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/test.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-security-group/actions/workflows/test.yaml)
78

89
### Security
910
[![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)

‎docs/logo.md

-1
This file was deleted.

‎examples/basic-example/variables.tf

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ variable "name" {
22
default = "test-security-group"
33
description = "Security group name."
44
type = string
5-
}
5+
}

0 commit comments

Comments
 (0)