Skip to content

feat(docs): autogenerate API documentation #40628

feat(docs): autogenerate API documentation

feat(docs): autogenerate API documentation #40628

name: Verify Docs Quality
on:
pull_request:
branches: [master]
paths:
- '.github/workflows/verify_docs-quality.yml'
- '**.md'
jobs:
check-all-files:
runs-on: ubuntu-latest
steps:
- name: Harden Runner
uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
with:
egress-policy: audit
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
# Vale does not support file excludes, so we use the script to generate a list of files instead
# The action also does not allow args or a local config file to be passed in, so the files array
# also contains an "--config=.github/vale/config.ini" option
- name: generate vale args
id: generate
run: echo "args=$(node scripts/check-docs-quality.js --ci-args)" >> $GITHUB_OUTPUT
- name: documentation quality check
uses: errata-ai/vale-action@d89dee975228ae261d22c15adcd03578634d429c # v2.1.1
with:
# This also contains --config=.github/vale/config.ini ... :/
files: '${{ steps.generate.outputs.args }}'
version: latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}