Skip to content
Open
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
21 changes: 21 additions & 0 deletions agent/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,27 @@
Use workflows that run on push events to automate reactive maintenance tasks like updating API references or identifying documentation updates needed for new features.
</Tip>

## Run history

The [Workflows](https://dashboard.mintlify.com/products/workflows) page in the dashboard has a **Run history** tab that shows a unified view of all workflow runs across your project.

Each run displays:

- **Time** — when the workflow ran.

Check warning on line 30 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L30

Don't put a space before or after a dash.
- **Workflow** — which workflow triggered the run.

Check warning on line 31 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L31

Don't put a space before or after a dash.
- **Status** — the current state of the run: queued, running, failed, PR merged, PR closed, review needed, or no action needed.

Check warning on line 32 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L32

Don't put a space before or after a dash.
- **Summary** — a brief description of what the agent did.

Check warning on line 33 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L33

Don't put a space before or after a dash.

Use the workflow filter dropdown to view runs for a specific workflow. By default, the run history shows only runs with open pull requests. Toggle **Show all runs** to include runs where the pull request was already merged or closed.

### Close a pull request

If a workflow run opened a pull request that you don't want to merge, you can close it directly from the run history table without navigating to GitHub. Click the **Close PR** button on the run entry.

### View changes in the editor

Each run links to its branch in the dashboard editor so you can review the agent's changes before merging.

## Create a workflow

### Create a workflow in the dashboard
Expand Down Expand Up @@ -72,7 +93,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 a change is and how it affects users.

Check warning on line 96 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L96

Did you really mean 'informat'?

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

Expand Down Expand Up @@ -367,7 +388,7 @@
- If all pages have complete and reasonable metadata, do nothing.
```

### Changelog with notifications

Check warning on line 391 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L391

Use 'changelogs?' instead of 'Changelog'.

Runs weekly to generate a changelog and notify your team on Slack when the workflow completes. This example shows how to combine scheduled workflows with Slack notifications.

Expand Down
Loading