ci(docs): linting and formatting #580
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Command Doc Check | ||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
types: | ||
- opened | ||
- synchronize | ||
- reopened | ||
permissions: | ||
contents: read | ||
jobs: | ||
validate: | ||
runs-on: ubuntu-latest | ||
timeout-minutes: 10 | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Go | ||
uses: actions/setup-go@v4 | ||
with: | ||
go-version: 1.21 | ||
- name: Generate command docs | ||
run: go run ./scripts/gen-doc-yaml.go | ||
- name: Setup Node | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: "16" | ||
- name: Cache dependencies | ||
uses: actions/cache@v3 | ||
working-directory: ./docs | ||
with: | ||
path: ~/.npm | ||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | ||
restore-keys: | | ||
${{ runner.os }}-node- | ||
- name: Install dependencies | ||
run: npm ci | ||
working-directory: ./docs | ||
- name: prettier | ||
run: npm run prettier:fix | ||
working-directory: ./docs | ||
- name: Pick up any new files | ||
run: git add . | ||
- name: Check no uncommited changes | ||
run: git diff --exit-code |