Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions automations/index.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Automations overview"

Check warning on line 2 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L2

Use 'automations?' instead of 'Automations'.
sidebarTitle: "Overview"
description: "Automate content maintenance with Mintlify automations. Run the agent on a schedule or in response to GitHub and GitLab repository pushes."
keywords: ["automation", "automate", "cron", "agent", "automations"]
boost: 5
---

Automations run the agent automatically on a schedule or in response to changes in a repository. Each automation defines a prompt for the agent and a trigger for when to run it. Automations support both GitHub and GitLab repositories.

Check warning on line 9 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L9

Use 'automations?' instead of 'Automations'.

Check warning on line 9 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L9

Use 'automations?' instead of 'Automations'.

When an automation runs, the agent reads your project content and any connected repositories, then follows the prompt to make updates.

Expand All @@ -18,25 +18,34 @@

## Trigger types

Automations support three trigger types.

Check warning on line 21 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L21

Use 'automations?' instead of 'Automations'.

- **Content update**: Runs when content changes push to your Mintlify project repository, including pull request merges and direct pushes.
- **Code change**: Runs when a pull request merges in a connected source code repository.
- **Custom schedule**: Runs on a recurring schedule. Automations queue within 10 minutes of the scheduled time.

Check warning on line 25 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L25

Use 'automations?' instead of 'Automations'.

Each automation has exactly one trigger. You cannot combine trigger types in a single automation.

## Pull request grouping

Automations group related changes into a single pull request instead of opening a separate one for every change. When a later run produces more changes that belong with an open pull request, the agent appends them to that pull request rather than opening a duplicate. Grouping behavior depends on the automation. See [Predefined automations](/automations/reference) for each automation's behavior.

Check warning on line 31 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L31

Use 'automations?' instead of 'Automations'.

<Note>
Draft changelog, Draft improvements from assistant conversations, Draft improvements from user feedback, and custom automations do not group or append. Each run opens its own pull request with the changes from that run.
</Note>

## Reviewing automation pull requests in GitHub

When an automation opens or updates a pull request, Mintlify adds context directly to the PR so you can review without leaving GitHub.

- **PR title** includes the name of the automation that generated it, so you can identify automation PRs at a glance when scanning an open PR list.
- **PR description** summarizes what changed and why. Each time a run appends new changes to an existing PR, the description updates to show a running timeline of what each run contributed.
- **PR comments** for any runs that append changes, explaining the changes and which source code pull requests the agent used as context.
- **Reviewers** assigned based on who authored the source code changes that triggered the update. Applies to automations that use source code repositories as context.

## Usage limits

Automation runs count toward your credit usage. The credits a single run consumes depend on the size of the task: how much content the agent reads, how many files it changes, and how long the run takes. Larger context repositories and broader prompts use more credits than narrowly scoped ones.

Check warning on line 48 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L48

Use 'automations?' instead of 'Automation'.

See your credit usage, set overages, and manage your credit package on the [Usage](https://app.mintlify.com/settings/organization/usage) page of your dashboard.

Expand Down
Loading