Skip to content

Commit 1bd01d4

Browse files
authored
chore(gh): add docs hcl workflow (#316)
Reviews the formatting of the HCL in the both `docs/` and `examples/` using `terrafmt` and the `GNUmakefile`. Signed-off-by: Ryan Johnson <[email protected]>
1 parent 3b93cc2 commit 1bd01d4

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

.github/workflows/docs.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Check Documentation
2+
3+
on:
4+
pull_request:
5+
6+
permissions:
7+
contents: read
8+
9+
jobs:
10+
docs:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
15+
- name: Install Tools
16+
run: make tools
17+
- name: Check HCL in Documentation
18+
run: make docs-hcl-lint

GNUmakefile

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
export PATH := $(shell go env GOPATH)/bin:$(PATH)
2+
13
TEST ?= $(shell go list ./... | grep -v 'vendor')
24
GOFMT_FILES ?= $(shell find . -name '*.go' | grep -v vendor)
35
PKG_NAME = vmc
@@ -39,7 +41,6 @@ test-compile:
3941
go test -c $(TEST) $(TESTARGS)
4042

4143
tools:
42-
GO111MODULE=on go install github.com/golangci/golangci-lint/cmd/golangci-lint
4344
GO111MODULE=on go install -mod=mod github.com/katbyte/terrafmt
4445

4546
docs-hcl-lint:

0 commit comments

Comments
 (0)