-
Notifications
You must be signed in to change notification settings - Fork 975
42 lines (32 loc) · 1.22 KB
/
documentation-check.yaml
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: "Documentation Updates"
# on:
# pull_request:
# paths:
# - 'docs/**'
# types: [opened, synchronize, labeled]
# push:
# branches:
# - main
# jobs:
# check-docs:
# runs-on: ubuntu-latest
# if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-documentation') }}
# steps:
# - name: Checkout repository
# uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
# - name: Set up Go
# uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
# with:
# go-version-file: 'go.mod'
# - name: Install tfplugindocs command
# run: go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest
# - name: Run tfplugindocs command
# run: tfplugindocs generate
# - name: Check for changes
# run: |
# git diff --exit-code
# - name: Undocumented changes
# run: |
# echo 'Documentation is not up to date. Please refer to the `Making Changes` in the Contribution Guide on how to properly update documentation.'
# exit 1
# if: failure()