Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/ci-check-skill-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
---

ci: add a `Check Skill Docs` job that runs `check:skill-docs` on PRs touching
`skills/**`, the skills guide, or the generator — failing if the generated
README/guide listings drift from the `SKILL.md` frontmatter. CI-only, no
package change.
47 changes: 46 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ jobs:
outputs:
docs: ${{ steps.changes.outputs.docs }}
core: ${{ steps.changes.outputs.core }}
skilldocs: ${{ steps.changes.outputs.skilldocs }}
steps:
- name: Checkout repository
uses: actions/checkout@v6

- uses: dorny/paths-filter@v4
id: changes
with:
Expand All @@ -30,6 +31,11 @@ jobs:
- 'content/**'
- 'pnpm-lock.yaml'
- '.github/workflows/ci.yml'
skilldocs:
- 'skills/**'
- 'content/docs/guides/skills.mdx'
- 'packages/spec/scripts/build-skill-docs.ts'
- '.github/workflows/ci.yml'
core:
- 'packages/**'
- 'examples/**'
Expand Down Expand Up @@ -224,3 +230,42 @@ jobs:

- name: Build Docs
run: pnpm --filter @objectstack/docs build

check-skill-docs:
name: Check Skill Docs
needs: filter
if: needs.filter.outputs.skilldocs == 'true'
runs-on: ubuntu-latest
permissions:
contents: read

steps:
- name: Checkout repository
uses: actions/checkout@v6

- name: Setup Node.js
uses: actions/setup-node@v6
with:
node-version: '20'

- name: Enable Corepack
run: corepack enable

- name: Get pnpm store directory
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV

- name: Setup pnpm cache
uses: actions/cache@v5
with:
path: ${{ env.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-v3-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-v3-

- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Check skill docs are generated from SKILL.md frontmatter
run: pnpm --filter @objectstack/spec check:skill-docs