mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
f99123ca26
* docs: fix Vale warnings from PRs merged in the last week * docs: mirror Vale style fixes into es, fr, and zh translations * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
51 lines
2.4 KiB
Plaintext
51 lines
2.4 KiB
Plaintext
---
|
|
title: "Workflows overview"
|
|
sidebarTitle: "Overview"
|
|
description: "Automate content maintenance with Mintlify workflows. Run the agent on a schedule or in response to GitHub and GitLab repository pushes."
|
|
keywords: ["automation", "automate", "cron", "agent", "workflows"]
|
|
boost: 5
|
|
---
|
|
|
|
Workflows run the agent automatically on a schedule or in response to changes in a repository. Each workflow defines a prompt for the agent and a trigger for when to run it. Workflows support both GitHub and GitLab repositories.
|
|
|
|
When a workflow runs, the agent reads your project content and any connected repositories, then follows the prompt to make updates.
|
|
|
|
<Tip>
|
|
Use workflows that run on a schedule for recurring tasks, like publishing changelogs or auditing SEO metadata.
|
|
|
|
Use workflows that trigger on content or code changes for reactive maintenance, like translations or updating content when source code changes.
|
|
</Tip>
|
|
|
|
## Trigger types
|
|
|
|
Workflows support three trigger types.
|
|
|
|
- **Content update**: Run when content changes push to your Mintlify project repository, including pull request merges and direct pushes.
|
|
- **Code change**: Run when a pull request merges in a connected source code repository.
|
|
- **Custom schedule**: Run on a recurring schedule. Workflows queue within 10 minutes of the scheduled time.
|
|
|
|
Each workflow has exactly one trigger. You cannot combine trigger types in a single workflow.
|
|
|
|
## Usage limits
|
|
|
|
Workflow runs count toward your credit usage. 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.
|
|
|
|
Each workflow can run up to 500 times per day. Runs that fail do not count toward this limit.
|
|
|
|
## Next steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Predefined workflows" icon="list" href="/workflows/reference">
|
|
Reference for all predefined workflows: triggers, update modes, and required configuration.
|
|
</Card>
|
|
<Card title="Manage workflows" icon="toggle-right" href="/workflows/manage">
|
|
Turn on predefined workflows and configure triggers, update mode, and context.
|
|
</Card>
|
|
<Card title="Create a custom workflow" icon="plus" href="/workflows/create">
|
|
Build a workflow with your own trigger, instructions, and context repositories.
|
|
</Card>
|
|
<Card title="Learn best practices" icon="book-open" href="/guides/use-workflows">
|
|
Choose the right trigger, write effective instructions, and review results.
|
|
</Card>
|
|
</CardGroup>
|