mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
fbc3f9f18d
* Update docs.json * update title in link * add link to new guide * Update index.mdx * first draft new guide * Update create.mdx * Update enable.mdx * add reference of predefined workflows * combine enable and manage * update links * Update reference.mdx * Update create.mdx * Update index.mdx * Update manage.mdx * Update use-workflows.mdx * update images * update workflow names * update workflow descriptions * clarify maintenance workflow cron vs push
49 lines
2.2 KiB
Plaintext
49 lines
2.2 KiB
Plaintext
---
|
|
title: "Create a custom workflow"
|
|
description: "Create a custom Mintlify workflow with a schedule or push trigger, context repositories, and an agent prompt to automate recurring documentation tasks."
|
|
keywords: ["automation", "automate", "cron", "agent", "custom workflow"]
|
|
---
|
|
|
|
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)
|
|
|
|
## Create a custom workflow
|
|
|
|
<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 [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) page in your dashboard.
|
|
2. Click **Create a custom workflow**.
|
|
3. Configure the workflow name, trigger, instructions, context repositories, and update mode.
|
|
4. Click **Create workflow**.
|
|
|
|
## Write effective instructions
|
|
|
|
Effective workflow instructions focus on a single task and define a clear, verifiable outcome. Workflows have some variance because agents are nondeterministic, but well formatted instructions produce more consistent results.
|
|
|
|
- **Describe the outcome.** Tell the agent what the result should look like of a successful run.
|
|
- **Write a procedure.** Give the agent a step-by-step guide to follow.
|
|
- **Keep scope narrow.** Split complex tasks across multiple workflows rather than combining them into one prompt.
|
|
|
|
For more examples and patterns, see [Use workflows](/guides/use-workflows).
|
|
|
|
<Tip>
|
|
Review the output of your custom workflows to confirm they work as expected. Update your instructions to improve the results.
|
|
</Tip>
|
|
|
|
<GitlabWorkflowSetup />
|
|
|
|
## Delete a custom workflow
|
|
|
|
Deleting a workflow is permanent and removes its configuration and run history.
|
|
|
|
1. Go to the [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) page in your dashboard.
|
|
2. Click the <Icon icon="settings" /> settings button beside a workflow.
|
|
3. Click **Delete**.
|