c1a1767034
- Add generate_block_docs.py script that introspects block code to
generate markdown
- Support manual content preservation via <!-- MANUAL: --> markers
- Add migrate_block_docs.py to preserve existing manual content from git
HEAD
- Add CI workflow (docs-block-sync.yml) to fail if docs drift from code
- Add Claude PR review workflow (docs-claude-review.yml) for doc changes
- Add manual LLM enhancement workflow (docs-enhance.yml)
- Add GitBook configuration (.gitbook.yaml, SUMMARY.md)
- Fix non-deterministic category ordering (categories is a set)
- Add comprehensive test suite (32 tests)
- Generate docs for 444 blocks with 66 preserved manual sections
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
<!-- Clearly explain the need for these changes: -->
### Changes 🏗️
<!-- Concisely describe all of the changes made in this pull request:
-->
### Checklist 📋
#### For code changes:
- [x] I have clearly listed my changes in the PR description
- [x] I have made a test plan
- [x] I have tested my changes according to the test plan:
<!-- Put your test plan here: -->
- [x] Extensively test code generation for the docs pages
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Introduces an automated documentation pipeline for blocks and
integrates it into CI.
>
> - Adds `scripts/generate_block_docs.py` (+ tests) to introspect blocks
and generate `docs/integrations/**`, preserving `<!-- MANUAL: -->`
sections
> - New CI workflows: **docs-block-sync** (fails if docs drift),
**docs-claude-review** (AI review for block/docs PRs), and
**docs-enhance** (optional LLM improvements)
> - Updates existing Claude workflows to use `CLAUDE_CODE_OAUTH_TOKEN`
instead of `ANTHROPIC_API_KEY`
> - Improves numerous block descriptions/typos and links across backend
blocks to standardize docs output
> - Commits initial generated docs including
`docs/integrations/README.md` and many provider/category pages
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
631e53e0f6. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2.4 KiB
GitHub CI
Blocks for retrieving CI check results from commits or pull requests, including overall status, pass/fail counts, and optional log searching.
Github Get CI Results
What it is
This block gets CI results for a commit or PR, with optional search for specific errors/warnings in logs.
How it works
This block retrieves CI check results for a specific commit or pull request using the GitHub Checks API. It aggregates results from all CI checks, providing an overall status summary along with individual check details.
Optionally search through CI logs using regex patterns to find specific errors or warnings. You can filter by check name to focus on particular CI jobs. The block returns comprehensive results including pass/fail counts and matched log lines.
Inputs
| Input | Description | Type | Required |
|---|---|---|---|
| repo | GitHub repository | str | Yes |
| target | Commit SHA or PR number to get CI results for | str | int | Yes |
| search_pattern | Optional regex pattern to search for in CI logs (e.g., error messages, file names) | str | No |
| check_name_filter | Optional filter for specific check names (supports wildcards) | str | No |
Outputs
| Output | Description | Type |
|---|---|---|
| error | Error message if the operation failed | str |
| check_run | Individual CI check run with details | Check Run |
| check_runs | List of all CI check runs | List[CheckRunItem] |
| matched_line | Line matching the search pattern with context | Matched Line |
| matched_lines | All lines matching the search pattern across all checks | List[MatchedLine] |
| overall_status | Overall CI status (pending, success, failure) | str |
| overall_conclusion | Overall CI conclusion if completed | str |
| total_checks | Total number of CI checks | int |
| passed_checks | Number of passed checks | int |
| failed_checks | Number of failed checks | int |
Possible use case
CI Status Monitoring: Check the overall CI status of commits or PRs before merging or deploying.
Error Diagnosis: Search CI logs for specific error patterns to quickly identify why builds are failing.
Automated PR Validation: Verify all required checks pass before automatically proceeding with merge or deployment workflows.