mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-01-23 05:57:58 -05:00

Files

Nicholas Tindle c1a1767034 feat(docs): Add block documentation auto-generation system (#11707 )

- 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>

2026-01-19 07:03:19 +00:00

8.4 KiB

Raw Blame History

GitHub Pull Requests

Blocks for managing GitHub pull requests including creating, reading, listing PRs, and assigning or unassigning reviewers.

Github Assign PR Reviewer

What it is

This block assigns a reviewer to a specified GitHub pull request.

How it works

This block requests a code review from a specific user on a GitHub pull request. It uses the GitHub API to add the specified username to the list of requested reviewers, triggering a notification to that user.

The reviewer must have access to the repository. Organization members can typically be assigned as reviewers on any repository they have at least read access to.

Inputs

Input	Description	Type	Required
pr_url	URL of the GitHub pull request	str	Yes
reviewer	Username of the reviewer to assign	str	Yes

Outputs

Output	Description	Type
error	Error message if the reviewer assignment failed	str
status	Status of the reviewer assignment operation	str

Possible use case

Automated Code Review Assignment: Automatically assign reviewers based on the files changed or the PR author.

Round-Robin Reviews: Distribute code review load evenly across team members.

Expertise-Based Routing: Assign reviewers who are experts in the specific area of code being modified.

Github List PR Reviewers

What it is

This block lists all reviewers for a specified GitHub pull request.

How it works

This block retrieves the list of requested reviewers for a GitHub pull request. It queries the GitHub API to fetch all users who have been requested to review the PR, returning their usernames and profile URLs.

This includes both pending review requests and users who have already submitted reviews.

Inputs

Input	Description	Type	Required
pr_url	URL of the GitHub pull request	str	Yes

Outputs

Output	Description	Type
error	Error message if listing reviewers failed	str
reviewer	Reviewers with their username and profile URL	Reviewer
reviewers	List of reviewers with their username and profile URL	List[ReviewerItem]

Possible use case

Review Status Monitoring: Check which reviewers have been assigned to a PR and send reminders to those who haven't responded.

Workflow Validation: Verify that required reviewers have been assigned before a PR can be merged.

Team Dashboard: Display reviewer assignments across multiple PRs for team visibility.

Github List Pull Requests

What it is

This block lists all pull requests for a specified GitHub repository.

How it works

This block fetches all open pull requests from a GitHub repository. It queries the GitHub API and returns a list of PRs with their titles and URLs, outputting both individual PRs and a complete list.

The block returns open pull requests by default, allowing you to monitor pending code changes in a repository.

Inputs

Input	Description	Type	Required
repo_url	URL of the GitHub repository	str	Yes

Outputs

Output	Description	Type
error	Error message if listing pull requests failed	str
pull_request	PRs with their title and URL	Pull Request
pull_requests	List of pull requests with their title and URL	List[PRItem]

Possible use case

PR Dashboard: Create a dashboard showing all open pull requests across your repositories.

Merge Queue Monitoring: Track pending PRs to prioritize code reviews and identify bottlenecks.

Stale PR Detection: List PRs to identify those that have been open too long and need attention.

Github Make Pull Request

What it is

This block creates a new pull request on a specified GitHub repository.

How it works

This block creates a new pull request on a GitHub repository. It uses the GitHub API to submit a PR from your source branch (head) to the target branch (base), with the specified title and description.

For cross-repository PRs, format the head branch as "username:branch". The branches must exist and have divergent commits for the PR to be created successfully.

Inputs

Input	Description	Type	Required
repo_url	URL of the GitHub repository	str	Yes
title	Title of the pull request	str	Yes
body	Body of the pull request	str	Yes
head	The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.	str	Yes
base	The name of the branch you want the changes pulled into.	str	Yes

Outputs

Output	Description	Type
error	Error message if the pull request creation failed	str
number	Number of the created pull request	int
url	URL of the created pull request	str

Possible use case

Automated Releases: Create PRs automatically when a release branch is ready to merge to main.

Dependency Updates: Programmatically create PRs for dependency updates after testing passes.

Feature Flags: Automatically create PRs to enable feature flags in configuration files.

Github Read Pull Request

What it is

This block reads the body, title, user, and changes of a specified GitHub pull request.

How it works

This block reads the details of a GitHub pull request including its title, description, author, and optionally the code diff. It fetches this information via the GitHub API using your credentials.

When include_pr_changes is enabled, the block also retrieves the full diff of all changes in the PR, which can be useful for code review automation or analysis.

Inputs

Input	Description	Type	Required
pr_url	URL of the GitHub pull request	str	Yes
include_pr_changes	Whether to include the changes made in the pull request	bool	No

Outputs

Output	Description	Type
error	Error message if reading the pull request failed	str
title	Title of the pull request	str
body	Body of the pull request	str
author	User who created the pull request	str
changes	Changes made in the pull request	str

Possible use case

Automated Code Review: Read PR content and changes to perform automated code analysis or send to AI for review.

Changelog Generation: Extract PR titles and descriptions to automatically compile release notes.

PR Summarization: Read PR details to generate summaries for stakeholder updates.

Github Unassign PR Reviewer

What it is

This block unassigns a reviewer from a specified GitHub pull request.

How it works

This block removes a reviewer from a GitHub pull request's review request list. It uses the GitHub API to remove the specified user from pending reviewers, which stops further review notifications to that user.

This is useful for reassigning reviews or removing reviewers who are unavailable.

Inputs

Input	Description	Type	Required
pr_url	URL of the GitHub pull request	str	Yes
reviewer	Username of the reviewer to unassign	str	Yes

Outputs

Output	Description	Type
error	Error message if the reviewer unassignment failed	str
status	Status of the reviewer unassignment operation	str

Possible use case

Reviewer Reassignment: Remove unavailable reviewers and replace them with available team members.

Load Balancing: Unassign reviewers who have too many pending reviews.

Vacation Coverage: Automatically remove reviewers who are out of office.

8.4 KiB Raw Blame History

GitHub Pull Requests

Github Assign PR Reviewer

What it is

How it works

Inputs

Outputs

Possible use case

Github List PR Reviewers

What it is

How it works

Inputs

Outputs

Possible use case

Github List Pull Requests

What it is

How it works

Inputs

Outputs

Possible use case

Github Make Pull Request

What it is

How it works

Inputs

Outputs

Possible use case

Github Read Pull Request

What it is

How it works

Inputs

Outputs

Possible use case

Github Unassign PR Reviewer

What it is

How it works

Inputs

Outputs

Possible use case

8.4 KiB

Raw Blame History