mirror of
https://github.com/OpenHands/OpenHands.git
synced 2025-12-26 05:48:36 +08:00
61 lines
2.8 KiB
Plaintext
61 lines
2.8 KiB
Plaintext
---
|
|
title: GitLab Integration
|
|
description: This guide walks you through the process of installing OpenHands Cloud for your GitLab repositories. Once
|
|
set up, it will allow OpenHands to work with your GitLab repository through the Cloud UI or straight from GitLab!.
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a GitLab account](/usage/cloud/openhands-cloud).
|
|
|
|
## Adding GitLab Repository Access
|
|
|
|
Upon signing into OpenHands Cloud with a GitLab account, OpenHands will have access to your repositories.
|
|
|
|
## Working With GitLab Repos in Openhands Cloud
|
|
|
|
After signing in with a Gitlab account, use the `Open Repository` section to select the appropriate repository and
|
|
branch you'd like OpenHands to work on. Then click on `Launch` to start the conversation!
|
|
|
|
|
|
|
|
## Using Tokens with Reduced Scopes
|
|
|
|
OpenHands requests an API-scoped token during OAuth authentication. By default, this token is provided to the agent.
|
|
To restrict the agent's permissions, [you can define a custom secret](/usage/settings/secrets-settings) `GITLAB_TOKEN`,
|
|
which will override the default token assigned to the agent. While the high-permission API token is still requested
|
|
and used for other components of the application (e.g. opening merge requests), the agent will not have access to it.
|
|
|
|
## Working on GitLab Issues and Merge Requests Using Openhands
|
|
|
|
<Note>
|
|
This feature works for personal projects and is available for group projects with a
|
|
[Premium or Ultimate tier subscription](https://docs.gitlab.com/user/project/integrations/webhooks/#group-webhooks).
|
|
|
|
A webhook is automatically installed within a few minutes after the owner/maintainer of the project or group logs into
|
|
OpenHands Cloud. If you decide to delete the webhook, then re-installing will require the support of All Hands AI but
|
|
we are planning to improve this in a future release.
|
|
</Note>
|
|
|
|
Giving GitLab repository access to OpenHands also allows you to work on GitLab issues and merge 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 merge 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 Merge Requests
|
|
|
|
To get OpenHands to work on merge requests, mention `@openhands` in the comments to:
|
|
- Ask questions
|
|
- Request updates
|
|
- Get code explanations
|
|
|
|
## Next Steps
|
|
|
|
- [Learn about the Cloud UI](/usage/cloud/cloud-ui).
|
|
- [Use the Cloud API](/usage/cloud/cloud-api) to programmatically interact with OpenHands.
|