mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-02-04 20:05:11 -05:00
90466908a8
<!-- 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>
91 lines
4.2 KiB
Markdown
91 lines
4.2 KiB
Markdown
# GitHub Checks
|
|
<!-- MANUAL: file_description -->
|
|
Blocks for creating and updating GitHub check runs, enabling custom CI integration and detailed status reporting on commits and pull requests.
|
|
<!-- END MANUAL -->
|
|
|
|
## Github Create Check Run
|
|
|
|
### What it is
|
|
Creates a new check run for a specific commit in a GitHub repository
|
|
|
|
### How it works
|
|
<!-- MANUAL: how_it_works -->
|
|
This block creates a new check run associated with a specific commit using the GitHub Checks API. Check runs represent individual test suites, linting tools, or other CI processes that report status against commits or pull requests.
|
|
|
|
You specify the commit SHA, check name, and current status. For completed checks, provide a conclusion (success, failure, or neutral) and optional detailed output including title, summary, and extended text for rich reporting in the GitHub UI.
|
|
<!-- END MANUAL -->
|
|
|
|
### Inputs
|
|
|
|
| Input | Description | Type | Required |
|
|
|-------|-------------|------|----------|
|
|
| repo_url | URL of the GitHub repository | str | Yes |
|
|
| name | The name of the check run (e.g., 'code-coverage') | str | Yes |
|
|
| head_sha | The SHA of the commit to check | str | Yes |
|
|
| status | Current status of the check run | "queued" \| "in_progress" \| "completed" \| "waiting" \| "requested" \| "pending" | No |
|
|
| conclusion | The final conclusion of the check (required if status is completed) | "success" \| "failure" \| "neutral" \| "cancelled" \| "timed_out" \| "action_required" \| "skipped" | No |
|
|
| details_url | The URL for the full details of the check | str | No |
|
|
| output_title | Title of the check run output | str | No |
|
|
| output_summary | Summary of the check run output | str | No |
|
|
| output_text | Detailed text of the check run output | str | No |
|
|
|
|
### Outputs
|
|
|
|
| Output | Description | Type |
|
|
|--------|-------------|------|
|
|
| error | Error message if check run creation failed | str |
|
|
| check_run | Details of the created check run | CheckRunResult |
|
|
|
|
### Possible use case
|
|
<!-- MANUAL: use_case -->
|
|
**Custom CI Integration**: Create check runs for external CI systems that aren't natively integrated with GitHub.
|
|
|
|
**Code Quality Reporting**: Report linting, security scan, or test coverage results directly on commits and PRs.
|
|
|
|
**Deployment Status**: Track deployment progress by creating check runs that show pending, in-progress, and completed states.
|
|
<!-- END MANUAL -->
|
|
|
|
---
|
|
|
|
## Github Update Check Run
|
|
|
|
### What it is
|
|
Updates an existing check run in a GitHub repository
|
|
|
|
### How it works
|
|
<!-- MANUAL: how_it_works -->
|
|
This block updates an existing check run's status, conclusion, and output details via the GitHub Checks API. Use it to report progress as your CI process advances through different stages.
|
|
|
|
You can update the status from queued to in_progress to completed, and set the final conclusion when done. The output fields allow you to provide detailed results, annotations, and summaries visible in the GitHub UI.
|
|
<!-- END MANUAL -->
|
|
|
|
### Inputs
|
|
|
|
| Input | Description | Type | Required |
|
|
|-------|-------------|------|----------|
|
|
| repo_url | URL of the GitHub repository | str | Yes |
|
|
| check_run_id | The ID of the check run to update | int | Yes |
|
|
| status | New status of the check run | "queued" \| "in_progress" \| "completed" \| "waiting" \| "requested" \| "pending" | Yes |
|
|
| conclusion | The final conclusion of the check (required if status is completed) | "success" \| "failure" \| "neutral" \| "cancelled" \| "timed_out" \| "action_required" \| "skipped" | Yes |
|
|
| output_title | New title of the check run output | str | No |
|
|
| output_summary | New summary of the check run output | str | No |
|
|
| output_text | New detailed text of the check run output | str | No |
|
|
|
|
### Outputs
|
|
|
|
| Output | Description | Type |
|
|
|--------|-------------|------|
|
|
| error | Error message if the operation failed | str |
|
|
| check_run | Details of the updated check run | CheckRunResult |
|
|
|
|
### Possible use case
|
|
<!-- MANUAL: use_case -->
|
|
**Progress Reporting**: Update check runs as your CI pipeline progresses through build, test, and deployment stages.
|
|
|
|
**Real-Time Feedback**: Provide immediate feedback on pull requests as tests complete, rather than waiting for the entire suite.
|
|
|
|
**Failure Details**: Update check runs with detailed error messages and output when tests fail.
|
|
<!-- END MANUAL -->
|
|
|
|
---
|