Skip to content

docs(brand): normalize horizontal logo height to 260 #67

docs(brand): normalize horizontal logo height to 260

docs(brand): normalize horizontal logo height to 260 #67

Workflow file for this run

name: Documentation
on:
push:
branches: ["main"]
paths:
- 'examples/**/*.tf'
- 'docs/**'
- '.github/workflows/docs.yml'
pull_request:
branches: ["main"]
paths:
- 'examples/**/*.tf'
- 'docs/**'
- '.github/workflows/docs.yml'
permissions:
contents: write
pull-requests: write
jobs:
terraform-docs:
runs-on: [self-hosted, linux]
steps:
- uses: actions/checkout@v7
with:
ref: ${{ github.event.pull_request.head.ref }}
repository: ${{ github.event.pull_request.head.repo.full_name }}
- uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6
with:
go-version-file: "go.mod"
- name: Install terraform-docs
# Pinned to v0.20.0 — the version shipped by terraform-docs/gh-actions@v1.4.1.
# The Docker action fails on the containerized self-hosted runner because
# workspace bind-mounts don't resolve in the host docker daemon.
run: go install github.com/terraform-docs/terraform-docs@v0.20.0
- name: Generate docs for examples
run: |
for dir in examples/basic examples/flash-firmware examples/full-provisioning examples/talos-cluster examples/k3s-cluster; do
terraform-docs --output-file README.md --output-mode inject "$dir"
done
- name: Check for uncommitted changes
run: |
if [[ -n $(git status --porcelain) ]]; then
echo "::error::terraform-docs would update documentation. Run 'terraform-docs .' in each example directory and commit the changes."
git diff
exit 1
fi