Skip to content

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

Draft
filipagr wants to merge 1 commit into
mainfrom
filipa/docs-sync-design
Draft

filipagr wants to merge 1 commit into
mainfrom
filipa/docs-sync-design

Conversation

@filipagr

Copy link
Copy Markdown
Contributor

This is the docs-repo half of the docs sync system in fil-one/fil-one#881. That workflow drafts docs.fil.one updates from product PRs and opens them here as draft PRs on docs-sync/fil-one-<PR#> branches.

  • .github/workflows/build.yaml runs npm ci --ignore-scripts && npm run build on every PR and on pushes to main. It has a read-only token and no secrets, because a PR's MDX runs during the build. Actions are pinned by SHA.
  • AGENTS.md gets a section on drafted PRs. The bot may edit only docs/** and the two llms mirrors. It lists other changes under "Manual follow-ups" and claims it couldn't confirm under "Needs verification". The drafts stay as drafts until the product PR merges. Pushing a commit to the branch takes it over from the bot.

No docs content changes, so llms.txt and llms-full.txt are unchanged. npm run build passes locally.

Manual setup still needed in this repo (details in docs/DocsSync.md in fil-one/fil-one#881):

  • Install the docs-sync GitHub App here only, and keep it off the main ruleset's bypass list.
  • Create the docs-sync label.

🤖 Generated with Claude Code

Adds a no-secrets build check for PRs, which the drafts opened by the
fil-one docs sync workflow rely on, and tells reviewers and agents how
those drafts are handled.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
filone-docs Ready Ready Preview Oct 21, 2026 1:26pm UTC

Request Review

@bajtos bajtos left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a great idea to add a CI!

A few more suggestions to consider as follow-ups:

  1. Configure Dependabot to automatically update the pinned actions and also npm dependencies. See https://github.com/fil-one/fil-one/blob/main/.github/dependabot.yml for inspiration.
  2. Change the branch protection ruleset to require passing CI checks before a PR can be merged.

This branch was successfully deployed

1 active deployment
Preview — 087b5365 Deployed Oct 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants