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
14 changes: 9 additions & 5 deletions agent/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
Workflows are in beta. They're currently free for all plans during the beta period. Workflow features, availability, and pricing are subject to change.
</Info>

Workflows run the agent automatically on a schedule or on a push to a repository. Each workflow defines a prompt for the agent and a trigger for when to run it.
Workflows run the agent automatically on a schedule or on a push to 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 clones any specified repositories as context, follows the prompt, and either opens a pull request or pushes changes directly to your deployment branch.
When a workflow runs, the agent clones any specified repositories as context, follows the prompt, and either opens a pull request (or merge request for GitLab) or pushes changes directly to your deployment branch.

Each workflow can run up to 50 times a day. Runs that fail do not count toward this limit.

Expand Down Expand Up @@ -73,7 +73,7 @@

Review all changes since the last changelog update. Draft a new changelog post with any new features, bug fixes, or breaking changes.

Include information about what changed and how it affects users.

Check warning on line 76 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L76

Did you really mean 'informat'?

Do not include any internal-only information or minor changes like bumping package versions or updating documentation.

Expand All @@ -90,7 +90,9 @@
| `automerge` | No | Defaults to `false`, which opens a pull request for review. If `true`, opens a pull request and automatically merges it. |
| `notify` | No | Notification configuration. Send Slack messages when workflows complete. |

You must have the Mintlify GitHub App installed on every repository listed in the `context` or `on.push.repo` fields. Add new repositories on the [GitHub app](https://dashboard.mintlify.com/settings/organization/github-app) page of your Mintlify dashboard.
For GitHub repositories, you must have the Mintlify GitHub App installed on every repository listed in the `context` or `on.push.repo` fields. Add new repositories on the [GitHub app](https://dashboard.mintlify.com/settings/organization/github-app) page of your Mintlify dashboard.

For GitLab repositories, you must have the [GitLab integration](/deploy/gitlab) configured with a valid access token and webhook.

<Frame>
<img src="/images/github/app-repos-light.png" alt="The GitHub app page showing connected repositories for two organizations." className="block dark:hidden" />
Expand Down Expand Up @@ -131,7 +133,7 @@
branch: main
```

- `repo`: The GitHub repository in `owner/repo` format.
- `repo`: The repository in `owner/repo` format.
- `branch` (optional): The branch to watch for pushes. If you don't specify a branch, the workflow triggers on pushes to the repository's default branch.

A workflow can watch for pushes to multiple repositories or branches.
Expand Down Expand Up @@ -159,7 +161,9 @@
By default, the agent opens a pull request for each workflow run so you can review changes before they go live. Set `automerge: true` to automatically merge the pull request without requiring manual approval. This gives you a record of changes in your repository's pull request history while automating the merge step.

<Note>
Automerge requires the Mintlify GitHub App to have bypass permissions on all rulesets that target your deploy branch, including organization-level and repository-level rulesets. See [Configure automerge](/guides/configure-automerge) for setup instructions.
For GitHub repositories, automerge requires the Mintlify GitHub App to have bypass permissions on all rulesets that target 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 access token configured in your [GitLab integration](/deploy/gitlab). Ensure the token has sufficient permissions to merge a merge requests on the target branch.
</Note>

```yaml
Expand Down Expand Up @@ -209,9 +213,9 @@

## Manage workflows

If you create a workflow in the dashboard, edit or delete it from the dashboard.

Check warning on line 216 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L216

Use the Oxford comma in 'If you create a workflow in the dashboard, edit or'.

If you create a workflow from a file in your repository, edit or delete it with a pull request modifying the file.

Check warning on line 218 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L218

Use the Oxford comma in 'If you create a workflow from a file in your repository, edit or'.

### Trigger a workflow manually

Expand All @@ -232,7 +236,7 @@
2. Click **View Workflows**.
3. Click the toggle next to the workflow you want to disable or enable.

When you re-enable a cron-based workflow, its next run time is recalculated from the current time.

Check warning on line 239 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L239

In general, use active voice instead of passive voice ('is recalculated').

## Prompts

Expand Down
Loading