Skip to content
Open
Show file tree
Hide file tree
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: 14 additions & 0 deletions workflows/enable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,20 @@

If you want to change the default, select a different trigger.

#### Batched updates for codebase changes on a schedule

When the **Codebase updates** workflow runs on a schedule, the agent batches its work instead of acting on a single push. At the start of each run, the agent:

Check warning on line 61 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L61

Use 'codebases?' instead of 'Codebase'.

1. Reads the list of source pull requests merged into your trigger repositories since the previous scheduled run.
2. Groups related pull requests by product, feature, or API surface.
3. Opens one documentation pull request per group, or appends to an open documentation pull request when the same group already has one in progress.

If no source pull requests have merged since the last run, the workflow completes without opening or updating any documentation pull requests.

<Tip>
Use a scheduled trigger when several pull requests typically ship for the same feature and you want one consolidated documentation pull request per feature. Use a push trigger when you want a documentation pull request for every merged source pull request.
</Tip>

### Instructions

Add optional instructions appended to the workflow's base prompt. Use these instructions to adjust the style, tone, or other aspects unique to your project.
Expand All @@ -72,6 +86,6 @@

#### Run a translation immediately

After saving the workflow, click **Translate now** to run it on demand using the currently saved target languages. The workflow must be enabled to trigger a manual run. Manual runs do not affect the workflow's regular trigger.

Check warning on line 89 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L89

In general, use active voice instead of passive voice ('be enabled').

<GitlabWorkflowSetup />
4 changes: 2 additions & 2 deletions workflows/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@
When a workflow runs, the agent clones any specified repositories as context and follows the prompt.

<Tip>
Use workflows that run on a schedule to automate recurring tasks, like publishing changelogs or checking for grammar and style issues.
Use workflows that run on a schedule to automate recurring tasks, like publishing changelogs, checking for grammar and style issues, or batching documentation updates for source code changes merged during the period.

Use workflows that run on push events to automate reactive maintenance tasks, like updating API reference documentation or identifying documentation updates needed for new features.
Use workflows that run on push events to automate reactive maintenance tasks, like updating API reference documentation or identifying documentation updates needed for individual pull requests.
</Tip>

## Trigger types

Workflows support two trigger types.

- **Schedule (cron)** — Run on a recurring daily, weekly, or monthly schedule. Workflows queue within 10 minutes of the scheduled time.

Check warning on line 23 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L23

Don't put a space before or after a dash.
- **Push events** — Run when changes push to a specific repository or branch, including pull request merges and direct pushes.

Check warning on line 24 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L24

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

You cannot combine trigger types in a single workflow. Each workflow has exactly one trigger.

Expand Down
Loading