terraform-provider-azurerm/.github/workflows/website-lint.yaml at 5f5fe93087d5df8c50adbbc5ed09f0f632925417 · hashicorp/terraform-provider-azurerm · GitHub

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
43
44
---
name: Website Linting

permissions:
  contents: read
  pull-requests: write

on:
  pull_request:
    types: ["opened", "synchronize"]
    paths:
      - ".github/workflows/website-lint.yaml"
      - "website/**"
      - "internal/services/**"

jobs:
  website-lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
        with:
          go-version-file: ./.go-version
      - run: bash scripts/gogetcookie.sh
      - run: make tools
      - run: make website-lint
      - run: make document-validate
      - name: Guidance on failure
        if: failure()
        run: |
          echo "::error::Website Linting failed."
          echo ""
          echo "Run 'make website-lint' and 'make document-validate' locally."
          echo "Check your documentation files under website/ for formatting or validation issues."
          echo "Common issues include: missing required frontmatter fields, incorrect markdown formatting,"
          echo "or mismatched resource documentation with the schema definition."
  save-artifacts-on-fail:
    needs: website-lint
    if: ${{ failure() }}
    uses: ./.github/workflows/save-artifacts.yaml
  comment-on-fail:
    needs: website-lint
    if: ${{ failure() }}
    uses: ./.github/workflows/comment-failure.yaml