Skip to content

ci: run doc-bot automatically on every pull request push - #25481

Open
mshabarov wants to merge 1 commit into
mainfrom
automatic-docs-bot
Open

ci: run doc-bot automatically on every pull request push#25481
mshabarov wants to merge 1 commit into
mainfrom
automatic-docs-bot

Conversation

@mshabarov

Copy link
Copy Markdown
Contributor

doc-bot ran only when a maintainer assigned vaadin-bot to an already merged pull request. It now runs on opened, reopened, synchronize and ready_for_review, and keeps the documentation pull request it opened in vaadin/docs in step with the source pull request rather than opening a new one per run.

Three filters keep it off pull requests that cannot need documentation, cheapest first: paths-ignore in the trigger, a conventional-commit type check on the title (test, ci, refactor, chore, build), and the agent's own classification of the diff. Assigning vaadin-bot stays as the manual override for a pull request the type filter passed over.

Whether a push is substantive is decided by git rather than a heuristic: each run analyses the whole pull request, writes onto the existing documentation branch, and stops when git reports no change. Working from the full diff rather than the increment keeps a run cancelled by a newer push from losing work.

vaadin/docs is checked out beside the source repository so the agent greps it locally instead of calling the code-search API, and the engine moves from Codex to Claude on the ANTHROPIC_API_KEY secret this repository already uses for claude.yml and diagram-bot.

doc-bot ran only when a maintainer assigned vaadin-bot to an already
merged pull request. It now runs on opened, reopened, synchronize and
ready_for_review, and keeps the documentation pull request it opened in
vaadin/docs in step with the source pull request rather than opening a
new one per run.

Three filters keep it off pull requests that cannot need documentation,
cheapest first: paths-ignore in the trigger, a conventional-commit type
check on the title (test, ci, refactor, chore, build), and the agent's
own classification of the diff. Assigning vaadin-bot stays as the manual
override for a pull request the type filter passed over.

Whether a push is substantive is decided by git rather than a heuristic:
each run analyses the whole pull request, writes onto the existing
documentation branch, and stops when git reports no change. Working from
the full diff rather than the increment keeps a run cancelled by a newer
push from losing work.

vaadin/docs is checked out beside the source repository so the agent
greps it locally instead of calling the code-search API, and the engine
moves from Codex to Claude on the ANTHROPIC_API_KEY secret this
repository already uses for claude.yml and diagram-bot.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@sonarqubecloud

sonarqubecloud Bot commented Sep 4, 2026

Copy link
Copy Markdown

@mshabarov
mshabarov requested a review from Artur- September 4, 2026 10:52
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Test Results

 1 434 files  ±0   1 518 suites  ±0   2h 2m 43s ⏱️ +11s
11 865 tests ±0  11 798 ✅ ±0  67 💤 ±0  0 ❌ ±0 
12 184 runs  ±0  12 116 ✅ ±0  68 💤 ±0  0 ❌ ±0 

Results for commit a0fa973. ± Comparison against base commit 3b704d9.

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.

1 participant