Skip to content

ci: build every PR; document docs-sync draft PRs in AGENTS.md #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
filipagr wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ci: build every PR; document docs-sync draft PRs in AGENTS.md #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 34 additions & 0 deletions .github/workflows/build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Build

# Builds every PR, including the drafts the fil-one docs sync workflow opens
# (see AGENTS.md). Holds no secrets: a PR's MDX runs during the build.

on:
pull_request:
push:
branches: [main]

permissions:
contents: read

concurrency:
group: build-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false

- uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v6
with:
node-version: 24
cache: npm

- run: npm ci --ignore-scripts --no-audit --no-fund

- run: npm run build
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,11 @@ npm run build
```

This catches MDX syntax errors (broken JSX, unclosed tags, invalid frontmatter) that won't show up just from reading the file.

## Drafts from the fil-one docs sync workflow

Some PRs here are drafted by an AI agent in the `fil-one/fil-one` repo's **Docs sync** workflow (design: `docs/DocsSync.md` in that repo). They come from the branch `docs-sync/fil-one-<PR number>`, carry the `docs-sync` label, and link to the product PR they follow. The rules above apply to them like any other change; the agent is told to follow this file.

- The agent may edit only `docs/**` and the two `static/llms*.txt` mirrors. Changes it needs elsewhere (`sidebars.js` for a new page, `docusaurus.config.js`, `vercel.json` redirects) are listed under "Manual follow-ups" in the PR body.
- Claims under "Needs verification" are the ones the code alone could not settle (region behaviour, a flag's production state). Confirm them before approving.
- The PR stays a draft until the product PR merges, and is regenerated on each push to the product PR. Push a commit to the branch to take it over: the workflow then stops regenerating it. Close the PR to stop it for good.
Loading