diff --git a/workflows/enable.mdx b/workflows/enable.mdx index 3fe0eb7f5..8b0e84347 100644 --- a/workflows/enable.mdx +++ b/workflows/enable.mdx @@ -56,6 +56,20 @@ Each workflow has a default for when it runs, either in response to changes in y 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: + +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. + + + 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. + + ### 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. diff --git a/workflows/index.mdx b/workflows/index.mdx index 12bf7c1d1..190b67246 100644 --- a/workflows/index.mdx +++ b/workflows/index.mdx @@ -11,9 +11,9 @@ Workflows run the agent automatically on a schedule or in response to pushes to When a workflow runs, the agent clones any specified repositories as context and follows the prompt. -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. ## Trigger types