Skip to content

refactor(provider): unify HTTP calls behind doJSON helper (97 files),… #233

refactor(provider): unify HTTP calls behind doJSON helper (97 files),…

refactor(provider): unify HTTP calls behind doJSON helper (97 files),… #233

Workflow file for this run

name: Docs CI
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
mdvalidate:
name: Validate Markdown Files
runs-on: ubuntu-latest
env:
GOARCH: amd64
GOOS: linux
steps:
- name: Check out code
uses: actions/checkout@v5
with:
fetch-depth: 1
- name: ⚙️ Setup Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: Markdown Link Validation
uses: gaurav-nelson/github-action-markdown-link-check@v1
- name: Schema/docs drift check
run: |
go run ./internal/tools/docsdriftlint . | tee docs-drift.out
status=${PIPESTATUS[0]}
{
echo "## Schema/docs drift check"
echo ""
if [ "$status" -eq 0 ]; then
echo "OK — every schema field is documented."
else
echo '```'
cat docs-drift.out
echo '```'
fi
} >> "$GITHUB_STEP_SUMMARY"
exit $status
- name: Docs presence check
run: |
bash scripts/docs-presence-check.sh | tee docs-presence.out
status=${PIPESTATUS[0]}
missing=$(grep -c '\.md$' docs-presence.out || true)
{
echo "## Docs presence check"
echo ""
if [ "$status" -eq 0 ]; then
echo "OK — every resource and data source has a docs page."
else
echo "**Missing docs pages:** $missing"
echo ""
echo '```'
cat docs-presence.out
echo '```'
fi
} >> "$GITHUB_STEP_SUMMARY"
exit $status
- name: Examples presence check
run: |
bash scripts/examples-presence-check.sh | tee examples-presence.out
status=${PIPESTATUS[0]}
{
echo "## Examples presence check"
echo ""
if [ "$status" -eq 0 ]; then
echo "OK — every resource and data source has an example."
else
echo '```'
cat examples-presence.out
echo '```'
fi
} >> "$GITHUB_STEP_SUMMARY"
exit $status