Files
AutoGPT/docs/integrations/block-integrations/github/ci.md
Nicholas Tindle 90466908a8 refactor(docs): restructure platform docs for GitBook and remove MkDo… (#11825)
<!-- Clearly explain the need for these changes: -->
we met some reality when merging into the docs site but this fixes it
### Changes 🏗️
updates paths, adds some guides
<!-- Concisely describe all of the changes made in this pull request:
-->
update to match reality
### 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] deploy it and validate

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Aligns block integrations documentation with GitBook.
> 
> - Changes generator default output to
`docs/integrations/block-integrations` and writes overview `README.md`
and `SUMMARY.md` at `docs/integrations/`
> - Adds GitBook frontmatter and hint syntax to overview; prefixes block
links with `block-integrations/`
> - Introduces `generate_summary_md` to build GitBook navigation
(including optional `guides/`)
> - Preserves per-block manual sections and adds optional `extras` +
file-level `additional_content`
> - Updates sync checker to validate parent `README.md` and `SUMMARY.md`
> - Rewrites `docs/integrations/README.md` with GitBook frontmatter and
updated links; adds `docs/integrations/SUMMARY.md`
> - Adds new guides: `guides/llm-providers.md`,
`guides/voice-providers.md`
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
fdb7ff8111. 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>
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: bobby.gaffin <bobby.gaffin@agpt.co>
2026-01-23 06:18:16 +00:00

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.