docs: Check formatting in CI (#15355)
This PR adds a CI step to ensure the docs are properly formatted. Release Notes: - N/A
This commit is contained in:
parent
04e25525bf
commit
58755a6c88
4 changed files with 35 additions and 9 deletions
2
.github/workflows/danger.yml
vendored
2
.github/workflows/danger.yml
vendored
|
@ -16,7 +16,7 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
|
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
|
||||||
|
|
||||||
- uses: pnpm/action-setup@v3
|
- uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3
|
||||||
with:
|
with:
|
||||||
version: 9
|
version: 9
|
||||||
|
|
||||||
|
|
24
.github/workflows/docs.yml
vendored
Normal file
24
.github/workflows/docs.yml
vendored
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
name: Docs
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- "docs/**"
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check_formatting:
|
||||||
|
name: "Check formatting"
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
|
||||||
|
|
||||||
|
- uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3
|
||||||
|
with:
|
||||||
|
version: 9
|
||||||
|
|
||||||
|
- run: pnpm dlx prettier . --check
|
||||||
|
working-directory: ./docs
|
2
docs/.prettierignore
Normal file
2
docs/.prettierignore
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
# Handlebars partials are not supported by Prettier.
|
||||||
|
*.hbs
|
Loading…
Add table
Add a link
Reference in a new issue