mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
f78b4adcd5
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
61 lines
2.9 KiB
Plaintext
61 lines
2.9 KiB
Plaintext
---
|
|
title: "Enable workflows"
|
|
description: "Enable workflows on your project. Select triggers, add context repositories, and set schedules."
|
|
keywords: ["cron", "push trigger", "automerge"]
|
|
---
|
|
|
|
import GitlabWorkflowSetup from '/snippets/gitlab-workflow-setup.mdx';
|
|
|
|
## Prerequisites
|
|
|
|
- A Mintlify project connected to a GitHub or GitLab repository
|
|
- For GitHub: the [Mintlify GitHub App](/deploy/github) installed on every repository you plan to use in the workflow
|
|
- For GitLab: a connected GitLab account (see [GitLab setup](#gitlab-setup) below)
|
|
|
|
## Enable workflows
|
|
|
|
1. Open the [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) page in your dashboard.
|
|
2. Click the toggle beside a workflow to enable it.
|
|
<Frame>
|
|
<img src="/images/workflows/workflows-dashboard-light.png" alt="The workflows dashboard." className="block dark:hidden" />
|
|
<img src="/images/workflows/workflows-dashboard-dark.png" alt="The workflows dashboard." className="hidden dark:block" />
|
|
</Frame>
|
|
3. Choose any required configurations.
|
|
<Frame>
|
|
<img src="/images/workflows/workflow-settings-light.png" alt="The configuration options for the codebase updates workflow." className="block dark:hidden" />
|
|
<img src="/images/workflows/workflow-settings-dark.png" alt="The configuration options for the codebase updates workflow." className="hidden dark:block" />
|
|
</Frame>
|
|
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](https://dashboard.mintlify.com/settings/organization/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**.
|
|
|
|
<Note>
|
|
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](/guides/configure-automerge) for setup instructions.
|
|
|
|
For GitLab repositories, automerge uses the GitLab OAuth connection and requires at least the Maintainer role on each project.
|
|
</Note>
|
|
|
|
### 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.
|
|
|
|
<GitlabWorkflowSetup />
|