+12
fcd7c979df
fcd7c979df
Co-authored-by: Artur <145776561+arturict@users.noreply.github.com> Co-authored-by: arturict <arturict@users.noreply.github.com> Co-authored-by: Thomas <thomas@ajnart.fr> Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com> Co-authored-by: Danura30082 <danura30082+github@gmail.com> Co-authored-by: Kushie <122986913+kushiemoon-dev@users.noreply.github.com> Co-authored-by: ajnart <thomas@ajnart.fr> Co-authored-by: ajnart <thomas@ajnart.dev> Co-authored-by: chenjun <chenjun@foxmail.com> Co-authored-by: Wikibear <wikibear@users.noreply.github.com> Co-authored-by: Bergasha <bergasha@gmail.com> Co-authored-by: leafyelin <43306196+leafyelin@users.noreply.github.com> Co-authored-by: Lucas Araujo <lucas.lra@gmail.com> Co-authored-by: GreenMonito <86085570+GreenMonito@users.noreply.github.com> Co-authored-by: Nerdy-Technician <roffo@nerdy-technician.social> Co-authored-by: Jun <34545896+jcstrong@users.noreply.github.com> Co-authored-by: Edmond Abraham <54119952+gitedmond@users.noreply.github.com> Co-authored-by: thrawnx <tight.bulb9384@fastmail.com> Co-authored-by: Chris <58918656+nordada@users.noreply.github.com> Co-authored-by: yi111 <153097222+Yi-111-a@users.noreply.github.com> Co-authored-by: Yanis <naamaneyanis@gmail.com> Co-authored-by: Wikibear <me@sej.de> Co-authored-by: alessiottavo <93441886+alessiottavo@users.noreply.github.com>
55 lines
1.6 KiB
YAML
55 lines
1.6 KiB
YAML
name: Validate documentation
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- "apps/docs/**"
|
|
- "apps/nextjs/src/app/api/**"
|
|
- "packages/definitions/src/**"
|
|
- "packages/widgets/src/**"
|
|
- "packages/custom-widgets/src/**"
|
|
- "packages/ui/src/**"
|
|
- "packages/workshop/src/**"
|
|
- "packages/api/src/**"
|
|
- "packages/auth/src/**"
|
|
- "packages/integrations/src/**"
|
|
- "tooling/**"
|
|
- "pnpm-lock.yaml"
|
|
- "package.json"
|
|
- "pnpm-workspace.yaml"
|
|
- "turbo.json"
|
|
- ".github/workflows/deployment-docs.yml"
|
|
- ".github/workflows/validate-docs.yml"
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
concurrency:
|
|
group: validate-docs-${{ github.event.pull_request.number || github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
docs:
|
|
name: Build and validate docs
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 15
|
|
env:
|
|
SKIP_ENV_VALIDATION: true
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
- name: Setup
|
|
uses: ./tooling/github/setup
|
|
- name: Validate the published API schema against the application
|
|
run: pnpm check:openapi
|
|
- name: Validate browser access and API schema rendering
|
|
run: pnpm exec vitest run 'apps/nextjs/src/app/api/[...trpc]/route.spec.ts' apps/docs/src/lib/openapi.spec.ts
|
|
- name: Build docs
|
|
run: pnpm --filter @homarr/docs build
|
|
env:
|
|
CI: "true"
|
|
- name: Validate exported links, search, and metadata
|
|
run: |
|
|
pnpm --filter @homarr/docs validate:links
|
|
pnpm --filter @homarr/docs verify:search
|
|
pnpm --filter @homarr/docs verify:seo
|