Skip to content

Commit 52e4e56

Browse files
jeanschmidtjeanschmidt
authored
Adding tooling and documentation for locally run tflint (#6370)
created a Makefile on `./terraform-aws-github-runner` to perform tflint actions, and replaced the tflint calls on CI (`tflint.yml`) with this makefile. This makes much easier to test locally and make sure to get green signals on CI. Reducing the loop time to fix small syntax bugs.
1 parent 2daff52 commit 52e4e56

File tree

3 files changed

+85
-93
lines changed

3 files changed

+85
-93
lines changed

‎.github/workflows/tflint.yml

+11-93
Original file line numberDiff line numberDiff line change
@@ -24,102 +24,20 @@ jobs:
2424
github_token: ${{ secrets.GITHUB_TOKEN }}
2525
tflint_version: v0.54.0
2626

27-
- name: Install Terraform
28-
uses: hashicorp/setup-terraform@v2
27+
- name: Install Tofu
28+
uses: opentofu/setup-opentofu@v1
2929
with:
30-
terraform_version: 1.5.1
30+
terraform_version: 1.5.7
3131
terraform_wrapper: false
3232

33-
- name: Show version
34-
run: tflint --version
33+
- name: Show tflint version
34+
run:
35+
tflint --version
3536

36-
- name: "Init TFLint download-lambda"
37-
working-directory: terraform-aws-github-runner/modules/download-lambda
38-
run: tflint --init
39-
- name: "Init terraform download-lambda"
40-
working-directory: terraform-aws-github-runner/modules/download-lambda
41-
run: terraform init
42-
- name: "Run TFLint download-lambda"
43-
working-directory: terraform-aws-github-runner/modules/download-lambda
44-
run: tflint --call-module-type=all
45-
- name: "Run terraform validate download-lambda"
46-
working-directory: terraform-aws-github-runner/modules/download-lambda
47-
run: terraform validate
37+
- name: Show tofu version
38+
run:
39+
tofu --version
4840

49-
- name: "Init TFLint runner-binaries-syncer"
50-
working-directory: terraform-aws-github-runner/modules/runner-binaries-syncer
51-
run: tflint --init
52-
- name: "Init terraform runner-binaries-syncer"
53-
working-directory: terraform-aws-github-runner/modules/runner-binaries-syncer
54-
run: terraform init
55-
- name: "Run TFLint runner-binaries-syncer"
56-
working-directory: terraform-aws-github-runner/modules/runner-binaries-syncer
57-
run: tflint --call-module-type=all
58-
- name: "Run terraform validate runner-binaries-syncer"
59-
working-directory: terraform-aws-github-runner/modules/runner-binaries-syncer
60-
run: terraform validate
61-
62-
- name: "Init TFLint runners-instances"
63-
working-directory: terraform-aws-github-runner/modules/runners-instances
64-
run: tflint --init
65-
- name: "Init terraform runners-instances"
66-
working-directory: terraform-aws-github-runner/modules/runners-instances
67-
run: terraform init
68-
- name: "Run TFLint runners-instances"
69-
working-directory: terraform-aws-github-runner/modules/runners-instances
70-
run: tflint --call-module-type=all
71-
- name: "Run terraform validate runners-instances"
72-
working-directory: terraform-aws-github-runner/modules/runners-instances
73-
run: terraform validate
74-
75-
- name: "Init TFLint runners"
76-
working-directory: terraform-aws-github-runner/modules/runners
77-
run: tflint --init
78-
- name: "Init terraform runners"
79-
working-directory: terraform-aws-github-runner/modules/runners
80-
run: terraform init
81-
- name: "Run TFLint runners"
82-
working-directory: terraform-aws-github-runner/modules/runners
83-
run: tflint --call-module-type=all
84-
- name: "Run terraform validate runners"
85-
working-directory: terraform-aws-github-runner/modules/runners
86-
run: terraform validate
87-
88-
- name: "Init TFLint setup-iam-permissions"
89-
working-directory: terraform-aws-github-runner/modules/setup-iam-permissions
90-
run: tflint --init
91-
- name: "Init terraform setup-iam-permissions"
92-
working-directory: terraform-aws-github-runner/modules/setup-iam-permissions
93-
run: terraform init
94-
- name: "Run TFLint setup-iam-permissions"
95-
working-directory: terraform-aws-github-runner/modules/setup-iam-permissions
96-
run: tflint --call-module-type=all
97-
- name: "Run terraform validate setup-iam-permissions"
98-
working-directory: terraform-aws-github-runner/modules/setup-iam-permissions
99-
run: terraform validate
100-
101-
- name: "Init TFLint webhook"
102-
working-directory: terraform-aws-github-runner/modules/webhook
103-
run: tflint --init
104-
- name: "Init terraform webhook"
105-
working-directory: terraform-aws-github-runner/modules/webhook
106-
run: terraform init
107-
- name: "Run TFLint webhook"
108-
working-directory: terraform-aws-github-runner/modules/webhook
109-
run: tflint --call-module-type=all
110-
- name: "Run terraform validate webhook"
111-
working-directory: terraform-aws-github-runner/modules/webhook
112-
run: terraform validate
113-
114-
- name: "Init TFLint main"
115-
working-directory: terraform-aws-github-runner
116-
run: tflint --init
117-
- name: "Init terraform main"
118-
working-directory: terraform-aws-github-runner
119-
run: terraform init
120-
- name: "Run TFLint main"
121-
working-directory: terraform-aws-github-runner
122-
run: tflint --call-module-type=all
123-
- name: "Run terraform validate terraform-aws-github-runner"
41+
- name: "tflint"
12442
working-directory: terraform-aws-github-runner
125-
run: terraform validate
43+
run: make tflint

‎terraform-aws-github-runner/Makefile

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
all: tflint
2+
3+
@PHONY: tflint
4+
tflint: tflint-download-lambda tflint-runner-binaries-syncer tflint-runners-instances tflint-runners tflint-setup-iam-permissions tflint-webhook tflint-main
5+
6+
@PHONY: tflint-download-lambda
7+
tflint-download-lambda:
8+
cd modules/download-lambda && \
9+
tofu init && \
10+
tflint --init && \
11+
tflint --call-module-type=all && \
12+
tofu validate
13+
14+
@PHONY: tflint-runner-binaries-syncer
15+
tflint-runner-binaries-syncer:
16+
cd modules/runner-binaries-syncer && \
17+
tofu init && \
18+
tflint --init && \
19+
tflint --call-module-type=all && \
20+
tofu validate
21+
22+
@PHONY: tflint-runners-instances
23+
tflint-runners-instances:
24+
cd modules/runners-instances && \
25+
tofu init && \
26+
tflint --init && \
27+
tflint --call-module-type=all && \
28+
tofu validate
29+
30+
@PHONY: tflint-runners
31+
tflint-runners:
32+
cd modules/runners && \
33+
tofu init && \
34+
tflint --init && \
35+
tflint --call-module-type=all && \
36+
tofu validate
37+
38+
@PHONY: tflint-setup-iam-permissions
39+
tflint-setup-iam-permissions:
40+
cd modules/setup-iam-permissions && \
41+
tofu init && \
42+
tflint --init && \
43+
tflint --call-module-type=all && \
44+
tofu validate
45+
46+
@PHONY: tflint-webhook
47+
tflint-webhook:
48+
cd modules/webhook && \
49+
tofu init && \
50+
tflint --init && \
51+
tflint --call-module-type=all && \
52+
tofu validate
53+
54+
@PHONY: tflint-main
55+
tflint-main:
56+
tofu init
57+
tflint --init
58+
tflint --call-module-type=all --recursive
59+
tofu validate
60+
61+
clean:
62+
rm -rf .terraform terraform.lock.hcl

‎terraform-aws-github-runner/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
This is a terraform module that sets up self hosted github runners on AWS along with the infra needed to autoscale them
44

5+
# Testing your changes
6+
In order to verify if your changes will pass CI testing, you can simply run from this directory:
7+
8+
```
9+
$ make tflint
10+
```
11+
12+
This depends on Tofu, CMake and TFLint being installed.
13+
14+
# Checking plan changes of your changes
15+
This module is not stand alone. It is a reusable module designed to be imported, configured, and used in your project.
16+
517
# Release
618
Terraform code that uses this module specify the tag (version of test-infra) that they use via a file called `Terrafile`. We need to create a new tag for any changes here that we want to deploy and update the `Terrafile` to refer to that tag:
719

0 commit comments

Comments
 (0)