Skip to content

docs: scheduled source code workflow and multi-PR runs #5947

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
Closed

docs: scheduled source code workflow and multi-PR runs #5947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions workflows/enable.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,25 @@ You can change the target languages at any time by opening the workflow's settin

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.

## New feature updates

The **New feature updates** workflow watches one or more source code repositories and proposes documentation changes that reflect what shipped.

You can run this workflow two ways:

- **On push** — The agent runs when a pull request merges to a watched repository and drafts updates for that change.
- **On a schedule** — The agent gathers pull requests merged to the watched repositories since the last run and drafts a combined set of updates. Use scheduled mode when you want a single batched review on a cadence instead of one pull request per code change.

### Configure source repositories

When you set the trigger to a schedule, the **Source repositories** field replaces the trigger repository selector. Add every repository whose merged pull requests should feed the run. You must select at least one source repository before you can save a scheduled workflow.

Merged pull requests from these repositories are collected before each scheduled run. Repository activity does not trigger the workflow — the schedule does.

### Updates always open for review

This workflow always opens a pull request against your docs repository. It does not support automerge, so the **How should updates be applied?** option does not appear in the settings modal. Review and merge each proposed change in your Git host.

## Improve docs from assistant chats

The **Improve docs from assistant chats** workflow reviews recent trends in [assistant](/assistant/index) questions and opens targeted documentation updates that address gaps your users hit.
Expand Down
6 changes: 6 additions & 0 deletions workflows/manage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,9 @@ Each workflow keeps a log of past runs, including the status and a summary of ch
<img src="/images/workflows/workflow-runs-light.png" alt="Workflow runs with the status filter menu open." className="block dark:hidden" />
<img src="/images/workflows/workflow-runs-dark.png" alt="Workflow runs with the status filter menu open." className="hidden dark:block" />
</Frame>

### Runs with multiple pull requests

A single run can produce more than one pull request. For example, a scheduled [New feature updates](/workflows/enable#new-feature-updates) workflow that watches several source repositories may open a separate documentation pull request for each.

When a run includes multiple pull requests, expand the run row to see every pull request the agent opened. Each entry shows its title, status, and source repository, and exposes its own **Merge** and **Close** actions so you can review them independently.
Loading