docs: document batched scheduled runs for codebase updates workflow#5868
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: document batched scheduled runs for codebase updates workflow#5868mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new scheduled trigger option for the Codebase updates workflow, which batches documentation updates from source pull requests merged since the previous run.
Changes
workflows/enable.mdx: Added a "Batched updates for codebase changes on a schedule" subsection under Trigger explaining how the agent collects merged source pull requests, groups them by product or feature area, and opens or appends to a documentation pull request per group.workflows/index.mdx: Updated the schedule vs. push tip to mention batched codebase documentation updates as a use case for scheduled triggers.Context
The Codebase updates workflow previously ran only on push events. It now also supports a schedule trigger that batches docs updates from all source pull requests merged since the last scheduled run, grouping related pull requests into a single documentation pull request per feature or product.
Note
Low Risk
Low risk: documentation-only changes clarifying scheduled vs push trigger behavior for the Codebase updates workflow.
Overview
Documents the new scheduled trigger batching behavior for the Codebase updates workflow, explaining that scheduled runs collect merged source PRs since the prior run, group them by feature/API area, and open or append to one docs PR per group (or do nothing if there are no new merges).
Updates the workflows overview tip to explicitly position scheduled triggers as useful for batching docs updates over a time window, while push triggers are for per-PR/reactive updates.
Reviewed by Cursor Bugbot for commit 0165dcf. Bugbot is set up for automated code reviews on this repo. Configure here.