Skip to content

Commit 9b8bb6c

Browse files
Document GitLab support for workflows (#5198)
* Document GitLab support for workflows and automerge Generated-By: mintlify-agent * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestions from code review Co-authored-by: Ethan Palm <[email protected]> * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <[email protected]>
1 parent 1331ad7 commit 9b8bb6c

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

agent/workflows.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ tag: "Beta"
99
Workflows are in beta. They're currently free for all plans during the beta period. Workflow features, availability, and pricing are subject to change.
1010
</Info>
1111

12-
Workflows run the agent automatically on a schedule or on a push to a repository. Each workflow defines a prompt for the agent and a trigger for when to run it.
12+
Workflows run the agent automatically on a schedule or on a push to a repository. Each workflow defines a prompt for the agent and a trigger for when to run it. Workflows support both GitHub and GitLab repositories.
1313

14-
When a workflow runs, the agent clones any specified repositories as context, follows the prompt, and either opens a pull request or pushes changes directly to your deployment branch.
14+
When a workflow runs, the agent clones any specified repositories as context, follows the prompt, and either opens a pull request (or merge request for GitLab) or pushes changes directly to your deployment branch.
1515

1616
Each workflow can run up to 50 times a day. Runs that fail do not count toward this limit.
1717

@@ -90,7 +90,9 @@ Success criteria: Someone who reads the changelog knows the most up to date info
9090
| `automerge` | No | Defaults to `false`, which opens a pull request for review. If `true`, opens a pull request and automatically merges it. |
9191
| `notify` | No | Notification configuration. Send Slack messages when workflows complete. |
9292

93-
You must have the Mintlify GitHub App installed on every repository listed in the `context` or `on.push.repo` fields. Add new repositories on the [GitHub app](https://dashboard.mintlify.com/settings/organization/github-app) page of your Mintlify dashboard.
93+
For GitHub repositories, you must have the Mintlify GitHub App installed on every repository listed in the `context` or `on.push.repo` fields. Add new repositories on the [GitHub app](https://dashboard.mintlify.com/settings/organization/github-app) page of your Mintlify dashboard.
94+
95+
For GitLab repositories, you must have the [GitLab integration](/deploy/gitlab) configured with a valid access token and webhook.
9496

9597
<Frame>
9698
<img src="/images/github/app-repos-light.png" alt="The GitHub app page showing connected repositories for two organizations." className="block dark:hidden" />
@@ -131,7 +133,7 @@ on:
131133
branch: main
132134
```
133135

134-
- `repo`: The GitHub repository in `owner/repo` format.
136+
- `repo`: The repository in `owner/repo` format.
135137
- `branch` (optional): The branch to watch for pushes. If you don't specify a branch, the workflow triggers on pushes to the repository's default branch.
136138

137139
A workflow can watch for pushes to multiple repositories or branches.
@@ -159,7 +161,9 @@ context:
159161
By default, the agent opens a pull request for each workflow run so you can review changes before they go live. Set `automerge: true` to automatically merge the pull request without requiring manual approval. This gives you a record of changes in your repository's pull request history while automating the merge step.
160162

161163
<Note>
162-
Automerge requires the Mintlify GitHub App to have bypass permissions on all rulesets that target your deploy branch, including organization-level and repository-level rulesets. See [Configure automerge](/guides/configure-automerge) for setup instructions.
164+
For GitHub repositories, automerge requires the Mintlify GitHub App to have bypass permissions on all rulesets that target your deploy branch, including organization-level and repository-level rulesets. See [Configure automerge](/guides/configure-automerge) for setup instructions.
165+
166+
For GitLab repositories, automerge uses the access token configured in your [GitLab integration](/deploy/gitlab). Ensure the token has sufficient permissions to merge a merge requests on the target branch.
163167
</Note>
164168

165169
```yaml

0 commit comments

Comments
 (0)