docs.yaml

#
name: Docs

on:
  push:
    branches:
      - main
  pull_request:
  workflow_call:
  workflow_dispatch:

permissions: {}

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  docchecks:
    name: Checks
    runs-on: ubuntu-latest
    outputs:
      linkcheck-result: ${{ steps.linkcheck-step.outcome }}
      spellcheck-result: ${{ steps.spellcheck-step.outcome }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          persist-credentials: false
      - name: Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Links
        id: linkcheck-step
        if: success() || failure()
        uses: canonical/documentation-workflows/linkcheck@aaeaf091e8f55145184ad897cb9834f224bd31de # main, 2026-03-21
        with:
          working-directory: docs
      - name: Spelling
        id: spellcheck-step
        if: success() || failure()
        uses: canonical/documentation-workflows/spellcheck@aaeaf091e8f55145184ad897cb9834f224bd31de # main, 2026-03-21
        with:
          working-directory: docs