mirror of
https://github.com/OpenHands/OpenHands.git
synced 2025-12-26 05:48:36 +08:00
73 lines
3.0 KiB
Plaintext
73 lines
3.0 KiB
Plaintext
---
|
|
title: GitHub Integration
|
|
description: This guide walks you through the process of installing OpenHands Cloud for your GitHub repositories. Once
|
|
set up, it will allow OpenHands to work with your GitHub repository through the Cloud UI or straight from GitHub!
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a GitHub account](/usage/cloud/openhands-cloud).
|
|
|
|
## Adding GitHub Repository Access
|
|
|
|
You can grant OpenHands access to specific GitHub repositories:
|
|
|
|
1. Click on `Add GitHub repos` on the landing page.
|
|
2. Select your organization and choose the specific repositories to grant OpenHands access to.
|
|
<Accordion title="OpenHands permissions">
|
|
- OpenHands requests short-lived tokens (8-hour expiration) with these permissions:
|
|
- Actions: Read and write
|
|
- Commit statuses: Read and write
|
|
- Contents: Read and write
|
|
- Issues: Read and write
|
|
- Metadata: Read-only
|
|
- Pull requests: Read and write
|
|
- Webhooks: Read and write
|
|
- Workflows: Read and write
|
|
- Repository access for a user is granted based on:
|
|
- Permission granted for the repository
|
|
- User's GitHub permissions (owner/collaborator)
|
|
</Accordion>
|
|
|
|
3. Click `Install & Authorize`.
|
|
|
|
## Modifying Repository Access
|
|
|
|
You can modify GitHub repository access at any time by:
|
|
- Selecting `Add GitHub repos` on the landing page or
|
|
- Visiting the Settings page and selecting `Configure GitHub Repositories` under the `Integrations` tab
|
|
|
|
## Working With GitHub Repos in Openhands Cloud
|
|
|
|
Once you've granted GitHub repository access, you can start working with your GitHub repository. Use the `select a repo`
|
|
and `select a branch` dropdowns to select the appropriate repository and branch you'd like OpenHands to work on. Then
|
|
click on `Launch` to start the conversation!
|
|
|
|
|
|
|
|
## Working on Github Issues and Pull Requests Using Openhands
|
|
|
|
Giving GitHub repository access to OpenHands also allows you to work on GitHub issues and pull requests directly.
|
|
|
|
### Working with Issues
|
|
|
|
On your repository, label an issue with `openhands` or add a message starting with `@openhands`. OpenHands will:
|
|
1. Comment on the issue to let you know it is working on it.
|
|
- You can click on the link to track the progress on OpenHands Cloud.
|
|
2. Open a pull request if it determines that the issue has been successfully resolved.
|
|
3. Comment on the issue with a summary of the performed tasks and a link to the PR.
|
|
|
|
### Working with Pull Requests
|
|
|
|
To get OpenHands to work on pull requests, mention `@openhands` in the comments to:
|
|
- Ask questions
|
|
- Request updates
|
|
- Get code explanations
|
|
|
|
**Important Note**: The `@openhands` mention functionality in pull requests only works if the pull request is both *to* and *from* a repository that you have added through the interface. This is because OpenHands needs appropriate permissions to access both repositories.
|
|
|
|
## Next Steps
|
|
|
|
- [Learn about the Cloud UI](/usage/cloud/cloud-ui).
|
|
- [Use the Cloud API](/usage/cloud/cloud-api) to programmatically interact with OpenHands.
|