Skip to content

Commit 7ff5ce8

Browse files
committed
chore: Use tf plugin docs
Signed-off-by: Steve Hipwell <[email protected]>
1 parent add2157 commit 7ff5ce8

631 files changed

Lines changed: 12941 additions & 5120 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ Resolves #ISSUE_NUMBER
77
### Before the change?
88
<!-- Please describe the current behavior that you are modifying. -->
99

10-
-
10+
-
1111

1212
### After the change?
1313
<!-- Please describe the behavior or changes that are being added by this PR. -->
1414

15-
-
15+
-
1616

1717
### Pull request checklist
1818

.github/workflows/ci.yaml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,53 @@ jobs:
3636
- run: make tools
3737
- run: make build
3838
- run: make test
39+
40+
docs:
41+
name: Documentation
42+
runs-on: ubuntu-latest
43+
permissions:
44+
contents: read
45+
defaults:
46+
run:
47+
shell: bash
48+
steps:
49+
- name: Checkout
50+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
51+
- name: Set-up Go
52+
uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6.2.0
53+
with:
54+
go-version-file: go.mod
55+
cache: true
56+
- name: Set-up Terraform
57+
uses: hashicorp/setup-terraform@5e8dbf3c6d9deaf4193ca7a8fb23f2ac83bb6c85 # v4.0.0
58+
with:
59+
terraform_version: latest
60+
terraform_wrapper: false
61+
- run: make checkdocs
62+
- run: make lintdocs RUMDL_ARGS="--output-format github"
63+
- uses: rvben/rumdl@f3ca9f4962234c3d2b73ac2ce15c0b6ca654d510 # v0.1.84
64+
with:
65+
path: ./docs
66+
report-type: annotations
67+
68+
check:
69+
name: Check
70+
needs:
71+
- ci
72+
- docs
73+
if: always()
74+
runs-on: ubuntu-latest
75+
defaults:
76+
run:
77+
shell: bash
78+
steps:
79+
- name: Check
80+
run: |
81+
set -euo pipefail
82+
results=( ${{ join(needs.*.result, ' ') }} )
83+
for result in "${results[@]}"; do
84+
if [[ "${result}" == "failure" ]] || [[ "${result}" == "cancelled" ]]; then
85+
echo "::error::Workflow failed!"
86+
exit 1
87+
fi
88+
done

.markdownlint.yaml

Lines changed: 0 additions & 4 deletions
This file was deleted.

.rumdl.toml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[global]
2+
disable = ["MD013", "MD028"]
3+
4+
[per-file-ignores]
5+
".github/pull_request_template.md" = ["MD041"]
6+
"docs/**/*.md" = ["MD059"]
7+
8+
[MD004]
9+
style = "dash"
10+
11+
[MD024]
12+
siblings-only = true
13+
14+
[MD033]
15+
allowed-elements = ["a", "br", "details", "img", "summary", "sub", "sup"]
16+
17+
[MD052]
18+
shortcut-syntax = true

0 commit comments

Comments
 (0)