Back to Autogpt

GitHub Statuses

docs/integrations/block-integrations/github/statuses.md

0.6.441.8 KB
Original Source

GitHub Statuses

<!-- MANUAL: file_description -->

Blocks for creating and managing GitHub commit statuses for CI/CD integration.

<!-- END MANUAL -->

Github Create Status

What it is

Creates a new commit status in a GitHub repository

How it works

<!-- MANUAL: how_it_works -->

This block creates a commit status using the GitHub Status API. Commit statuses are simpler than check runs and appear as colored indicators (pending yellow, success green, failure red, error red) on commits and pull requests.

Provide a context label to differentiate this status from others, an optional target URL for detailed results, and a description. Multiple statuses can exist on the same commit with different context labels.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
repo_urlURL of the GitHub repositorystrYes
shaThe SHA of the commit to set status forstrYes
stateThe state of the status (error, failure, pending, success)"error" | "failure" | "pending" | "success"Yes
target_urlURL with additional details about this statusstrNo
descriptionShort description of the statusstrNo
check_nameLabel to differentiate this status from othersstrNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
statusDetails of the created statusStatusResult

Possible use case

<!-- MANUAL: use_case -->

External CI Integration: Report build status from CI systems that don't have native GitHub integration.

Deployment Tracking: Set commit statuses to indicate deployment state (pending, deployed, failed).

Required Status Checks: Create statuses that GitHub branch protection rules require before merging.

<!-- END MANUAL -->