Back to Autogpt

GitHub Repo Branches

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

0.6.445.8 KB
Original Source

GitHub Repo Branches

<!-- MANUAL: file_description -->

Blocks for creating, listing, deleting, and comparing branches in GitHub repositories.

<!-- END MANUAL -->

Github Compare Branches

What it is

This block compares two branches or commits in a GitHub repository.

How it works

<!-- MANUAL: how_it_works -->

This block compares two branches or commits using the GitHub Compare API (/compare/base...head). It returns the comparison status (ahead, behind, diverged, or identical), commit counts, and a list of changed files with their diffs.

The block also builds a unified diff string from the patches of all changed files, making it easy to review the full set of changes at once.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
repo_urlURL of the GitHub repositorystrYes
baseBase branch or commit SHAstrYes
headHead branch or commit SHA to compare against basestrYes

Outputs

OutputDescriptionType
errorError message if comparison failedstr
statusComparison status: ahead, behind, diverged, or identicalstr
ahead_byNumber of commits head is ahead of baseint
behind_byNumber of commits head is behind baseint
total_commitsTotal number of commits in the comparisonint
diffUnified diff of all file changesstr
fileA changed file with its diffChanged File
filesList of changed files with their diffsList[FileChange]

Possible use case

<!-- MANUAL: use_case -->

Pre-Merge Review: Compare a feature branch against main to see all changes before creating a pull request.

Drift Detection: Check whether a long-lived branch has diverged from the base branch and needs rebasing.

Release Diffing: Compare two release tags or branches to generate a summary of changes between versions.

<!-- END MANUAL -->

Github Delete Branch

What it is

This block deletes a specified branch.

How it works

<!-- MANUAL: how_it_works -->

This block deletes a branch by sending a DELETE request to the GitHub Git Refs API at /git/refs/heads/{branch}. The branch name is URL-encoded to handle special characters.

The operation is permanent and cannot be undone. The block returns a success status message or an error if the deletion fails.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
repo_urlURL of the GitHub repositorystrYes
branchName of the branch to deletestrYes

Outputs

OutputDescriptionType
errorError message if the branch deletion failedstr
statusStatus of the branch deletion operationstr

Possible use case

<!-- MANUAL: use_case -->

Post-Merge Cleanup: Automatically delete feature branches after their pull requests have been merged.

Stale Branch Removal: Delete branches that are no longer active to keep the repository organized.

CI/CD Pipeline Cleanup: Remove temporary branches created by automated build or test processes.

<!-- END MANUAL -->

Github List Branches

What it is

This block lists all branches for a specified GitHub repository.

How it works

<!-- MANUAL: how_it_works -->

This block retrieves branches from a GitHub repository using the Branches API. It supports pagination with the per_page parameter to control how many branches are returned per request.

Each branch entry includes its name and a URL to browse the repository file tree at that branch.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
repo_urlURL of the GitHub repositorystrYes
per_pageNumber of branches to return per page (max 100)intNo
pagePage number for paginationintNo

Outputs

OutputDescriptionType
errorError message if listing branches failedstr
branchBranches with their name and file tree browser URLBranch
branchesList of branches with their name and file tree browser URLList[BranchItem]

Possible use case

<!-- MANUAL: use_case -->

Branch Inventory: List all branches to get an overview of active development streams in a repository.

Stale Branch Detection: Enumerate branches to identify those that may need cleanup or deletion.

Branch Validation: Verify that expected branches exist before running automated workflows.

<!-- END MANUAL -->

Github Make Branch

What it is

This block creates a new branch from a specified source branch.

How it works

<!-- MANUAL: how_it_works -->

This block creates a new branch by first fetching the latest commit SHA from the source branch via the Git Refs API, then creating a new git reference pointing to that same commit. This effectively branches off from the current tip of the source branch.

The block returns a success status message or an error if the branch creation fails.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
repo_urlURL of the GitHub repositorystrYes
new_branchName of the new branchstrYes
source_branchName of the source branchstrYes

Outputs

OutputDescriptionType
errorError message if the branch creation failedstr
statusStatus of the branch creation operationstr

Possible use case

<!-- MANUAL: use_case -->

Feature Branch Creation: Automatically create feature branches from the main branch when starting new tasks.

Release Branching: Create release branches from development branches as part of a release workflow.

Hotfix Isolation: Spin up hotfix branches from production branches to isolate urgent fixes.

<!-- END MANUAL -->