Enable workflows

Enable workflows on your Mintlify project. Configure GitHub or GitLab triggers, add context repositories, set schedules, and turn on automerge for the agent.

Prerequisites

• A Mintlify project connected to a GitHub or GitLab repository
• For GitHub: the Mintlify GitHub App installed on every repository you plan to use in the workflow
• For GitLab: a connected GitLab account (see GitLab setup below)

Enable workflows

1. Open the Workflows page in your dashboard.

2. Click the toggle beside a workflow to enable it.

   

3. Choose any required configurations.

   

4. Click Turn on workflow.

Configurations

Trigger repositories

For workflows that run on push events, specify the repositories to watch. You can specify up to 10 repositories per workflow.

For GitHub repositories, you must install the Mintlify GitHub App on each repository. Add repositories on the GitHub app settings page.

Update mode

Each workflow has a default mode for how it makes updates, either by directly updating your content repository or by opening a pull request.

If you want to require reviews before a workflow updates your content, select Require review.

For GitHub repositories, automatic updates require the Mintlify GitHub App to have bypass permissions on every ruleset targeting your deploy branch, including organization-level and repository-level rulesets. See Configure automerge for setup instructions.

For GitLab repositories, automerge uses the GitLab OAuth connection and requires at least the Maintainer role on each project.

Trigger

Each workflow has a default for when it runs, either in response to changes in your content repository, in response to changes in a trigger repository, or on a schedule.

If you want to change the default, select a different trigger.

Instructions

Add optional instructions appended to the workflow’s base prompt. Use these instructions to adjust the style, tone, or other aspects unique to your project.

Target languages

The translations workflow translates source content into the target languages you select. When you first enable the workflow, Mintlify pre-populates the target languages from the non-default languages defined in your docs.json navigation. You can change the selection at any time from the workflow’s settings.

• The workflow uses the default language from your docs.json navigation as the source language. If no default is set, Mintlify falls back to the first listed language, then to English.
• You can only select languages supported by Mintlify’s translation models. Unsupported or duplicate entries are ignored.
• The source language cannot be a target language.
• You must select at least one target language. The workflow will not run until at least one valid target language is configured.

If your project has no non-default languages configured in docs.json, you must choose target languages in the workflow settings before enabling the translations workflow.

GitLab setup

To use GitLab repositories in a workflow, connect each project through the GitLab OAuth settings page. Connect every repository the workflow touches—your documentation repository and any trigger or context repositories. You must have at least the Maintainer role on each project.

Workflows require a paid GitLab tier. The agent uses short-lived project access tokens for repository access, which GitLab’s Free plan does not support.