mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
a705c994bd
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
49 lines
2.3 KiB
Plaintext
49 lines
2.3 KiB
Plaintext
---
|
|
title: "Create a custom automation"
|
|
description: "Create a custom Mintlify automation with a schedule or push trigger, context repositories, and an agent prompt to automate recurring documentation tasks."
|
|
keywords: ["automation", "automate", "cron", "agent", "custom automation"]
|
|
---
|
|
|
|
import GitlabAutomationSetup from '/snippets/gitlab-automation-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 automation
|
|
- For GitLab: a connected GitLab account (see [GitLab setup](#gitlab-setup) below)
|
|
|
|
## Create a custom automation
|
|
|
|
<Note>
|
|
The agent runs in an isolated sandbox with restricted internet access. It cannot install additional packages or tools at runtime. Prompts that reference unavailable tools may produce unexpected results or fail.
|
|
</Note>
|
|
|
|
1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
|
|
2. Click **Create a custom automation**.
|
|
3. Configure the automation name, trigger, instructions, context repositories, integrations, and update mode. For details on each field, see [Configurations](/automations/manage#configurations).
|
|
4. Click **Create automation**.
|
|
|
|
## Write effective instructions
|
|
|
|
Effective automation instructions focus on a single task and define a clear, verifiable outcome. Automations have some variance because agents are nondeterministic, but well-formatted instructions produce more consistent results.
|
|
|
|
- **Describe the outcome.** Tell the agent what a successful run should look like.
|
|
- **Write a procedure.** Give the agent a step-by-step guide to follow.
|
|
- **Keep scope narrow.** Split complex tasks across multiple automations rather than combining them into one prompt.
|
|
|
|
For more examples and patterns, see [Use automations](/guides/use-automations).
|
|
|
|
<Tip>
|
|
Review the output of your custom automations to confirm they work as expected. Update your instructions to improve the results.
|
|
</Tip>
|
|
|
|
<GitlabAutomationSetup />
|
|
|
|
## Delete a custom automation
|
|
|
|
Deleting an automation is permanent and removes its configuration and run history.
|
|
|
|
1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
|
|
2. Click the <Icon icon="settings" /> settings button beside an automation.
|
|
3. Click **Delete**.
|