-
Notifications
You must be signed in to change notification settings - Fork 12
42 lines (33 loc) · 1017 Bytes
/
generate_docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
name: Generate Terraform Plugin Documentation
on:
pull_request:
branches:
- main
- stable-*
jobs:
generate-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version: 1.x
- name: Install dependencies
run: go get .
- name: Install tfplugindocs
run: go get github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest
- name: Build
run: go build -v ./...
- uses: hashicorp/setup-terraform@v3
with:
terraform_version: "1.10.4"
- name: Generate documentation
run: make generatedocs
- name: Check for doc changes
run: |
if git diff --exit-code -- ':!go.mod' ':!go.sum'; then
echo "Docs generation successful, no changes found."
else
echo "Error: Uncommitted changes found. Please run 'make generatedocs' and commit the changes."
exit 1
fi