Skip to content

πŸ™Œ OpenHands: AI-Driven Development

Update gitlab integration docs (#9025)

mamoodiaea37e52f7a7
diff --git a/docs/usage/cloud/github-installation.mdx b/docs/usage/cloud/github-installation.mdx
index 653e598189..ae0428b0c1 100644
--- a/docs/usage/cloud/github-installation.mdx
+++ b/docs/usage/cloud/github-installation.mdx
@@ -51,8 +51,7 @@ Giving GitHub repository access to OpenHands also allows you to work on GitHub i
### Working with Issues
-On your repository, label an issue with `openhands` or add a message starting with
-`@openhands`. OpenHands will:
+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.
diff --git a/docs/usage/cloud/gitlab-installation.mdx b/docs/usage/cloud/gitlab-installation.mdx
index 4f7aef6df8..46111d17e3 100644
--- a/docs/usage/cloud/gitlab-installation.mdx
+++ b/docs/usage/cloud/gitlab-installation.mdx
@@ -1,7 +1,7 @@
---
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.
+ set up, it will allow OpenHands to work with your GitLab repository through the Cloud UI or straight from GitLab!.
---
## Prerequisites
@@ -25,6 +25,33 @@ OpenHands requests an API-scoped token during OAuth authentication. By default,
To restrict the agent's permissions, you can define a custom secret `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).