> ## Documentation Index
> Fetch the complete documentation index at: https://developer.upsun.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Workflows in Upsun Dispatch

> Understand the built-in Upsun Dispatch workflows, how they start, and how workflow settings control their behavior.

Workflows are the automations Upsun Dispatch runs after your organization connects an integration and stores the required [AI model key](https://developer.upsun.com/dispatch/docs/models). A workflow listens for supported activity, creates a run, executes the work, and publishes results back to the relevant integration and the Upsun Dispatch console.

Upsun Dispatch currently provides three built-in workflows:

* **[Issue to code](https://developer.upsun.com/dispatch/docs/workflows/issue-to-code.md)** starts when an issue body or comment is exactly `@upsun-dispatch implement`, with an optional trailing `!`, `.`, or `?`, and turns the issue request into code work.
* **[Code review](https://developer.upsun.com/dispatch/docs/workflows/code-review.md)** reviews GitHub pull requests and GitLab merge requests, then publishes review feedback such as checks, statuses, comments, notes, and summaries.
* **[CVE scan](https://developer.upsun.com/dispatch/docs/workflows/cve-scan.md)** scans a GitHub repository or GitLab project for vulnerable dependencies. You can start it manually from the repository workflow page or enable a per-repository **Daily scan**. Latest results appear in [repository Security](https://developer.upsun.com/dispatch/docs/dashboard.md#view-repository-security).

For a compact list of built-in workflows and their supported triggers, see [Built-in workflows](https://developer.upsun.com/dispatch/docs/workflows/builtin).

## How workflows start

Workflows can start from integration events, comments, a console action, or a schedule, depending on the workflow and your settings.

### Automatic triggers

Trigger mode applies to **Code review only**. Its default is `automatic`, which means supported events can start Code review runs without a separate action from you. For Code review, this includes changes to connected GitHub pull requests and GitLab merge requests.

Code review uses wait behavior for rapid updates: if a new push arrives while a review is already running, Upsun Dispatch holds the new delivery and runs one fresh review after the active review finishes. This prevents a burst of pushes from creating redundant reviews.

Issue to code does not have an automatic or manual trigger mode. It starts only when the entire trimmed issue body or a comment is exactly `@upsun-dispatch implement`, with an optional trailing `!`, `.`, or `?`.

### Manual triggers

Some workflows can be started manually from comments or from the Upsun Dispatch console.

For **Code review**, users can request a review, force a full review, or request cancellation of an active review from the pull or merge request conversation:

* On GitHub pull requests, use whole-message commands addressed to the Upsun Dispatch bot, such as `@upsun-dispatch review`, `@upsun-dispatch full review`, or `@upsun-dispatch cancel`.
* On GitLab merge requests, use the bot username configured for that GitLab connection, such as `@<configured-bot-username> review`, `@<configured-bot-username> full review`, or `@<configured-bot-username> cancel`.

For **Issue to code**, the whole trimmed issue body or comment must be exactly `@upsun-dispatch implement`, with an optional trailing `!`, `.`, or `?`. Issue to code has no automatic or manual mode of its own. This exact issue command is the trigger. See [Issue to code](https://developer.upsun.com/dispatch/docs/workflows/issue-to-code.md) for examples and non-matching command behavior.

For **CVE scan**, start a manual scan from the Upsun Dispatch console at **Repository > Workflows > CVE scan** with **Run scan now**. To scan a repository each day, enable the per-repository **Daily scan** setting. See [CVE scan](https://developer.upsun.com/dispatch/docs/workflows/cve-scan.md#run-an-on-demand-scan) for scan steps and [repository Security](https://developer.upsun.com/dispatch/docs/dashboard.md#view-repository-security) for where the latest results appear.

Use `@upsun-dispatch help` to post command help. Ordinary comments that do not match a supported command are ignored.

You can observe runs in the Upsun Dispatch console, including viewing run details, following logs, and rerunning eligible terminal runs. See [Use the Upsun Dispatch console](https://developer.upsun.com/dispatch/docs/dashboard.md) for those actions.

## Workflow settings

Workflow settings control how Upsun Dispatch behaves for a workflow across your organization. Settings are available per configurable workflow and integration. **Daily scan** is a repository-level CVE scan setting, so it is configured on each repository that should be scanned daily.

In the top-level **Workflows** menu, use **Model integration** to choose which stored AI model key a workflow uses. Use **Quality level** to set the model effort level for that workflow. To add or manage stored model keys, see [AI models](https://developer.upsun.com/dispatch/docs/models).

Available settings include:

| Setting | Applies to | Default | What it controls |
| - | - | - | - |
| **Trigger mode** | Code review only | `automatic` | Choose whether supported Code review events start runs automatically or require manual action. |
| **Daily scan** | CVE scan repositories | `off` for each repository until enabled | Turn per-repository scheduled scanning on or off. Scheduled scans cover only repositories where this switch is on. See [Turn on daily scans for one repository](https://developer.upsun.com/dispatch/docs/workflows/cve-scan.md#turn-on-daily-scans-for-one-repository). |
| **Ignored authors** | Configurable workflows and integrations | No ignored authors | Set authors whose activity should not start workflow runs. |
| **Allow fork authors** | GitLab merge request review | `off` | Choose whether fork authors are admitted. |
| **Plan approval gate** | Jira-only for Issue to code; no separate plan approval gate for GitHub or Linear today. | `off` | Choose whether Issue to code pauses for approval at the plan step before continuing for Jira-triggered runs. |
| **Summary mode** | Review-producing workflows | `auto` | Choose how review summaries are published. The available values are `always`, `auto`, and `off`; `auto` is the default. |
| **AI model integration selection and pinning** | Configurable workflows | Organization default AI model key | Choose which stored AI model key a workflow uses, or let the workflow follow the organization default from [AI models](https://developer.upsun.com/dispatch/docs/models). |
| **Quality level** | Configurable workflows | Workflow setting | Set the model effort level Upsun Dispatch uses for workflow runs. |

> [!NOTE]
>
> Turning summary mode off stops Upsun Dispatch from publishing future summary content. It does not delete summaries that were already posted.

The Plan approval gate setting does not make Issue to code automatic. Issue to code still starts only from its exact trigger phrase. The gate only controls whether eligible Jira-triggered Issue to code runs pause at the plan step before continuing.

## Repository overrides

Organization-level workflow settings act as defaults. You can also create repository overrides for individual repositories when one repository needs different behavior from the rest of the organization.

Repository overrides pin selected settings for that repository independently from the organization default. For example, you can keep Code review automatic for most repositories while making one repository manual-only, or pin a repository to a specific stored AI model key.

Manage organization workflow settings and repository overrides from the top-level **Workflows** menu in the Upsun Dispatch console. See [Use the Upsun Dispatch console](https://developer.upsun.com/dispatch/docs/dashboard.md) for where to change these settings.

## Repository instruction files

You can also customize how Upsun Dispatch agents work in a repository by adding instruction files to that repository. These files let you write your own plain-language rules for the agents to consider during workflow runs.

Use repository instruction files for guidance that should travel with the code, such as coding conventions, test expectations, review priorities, or areas that require extra care. Keep the guidance short and specific so agents can apply it consistently.

`AGENTS.md` and `CLAUDE.md` are treated together as project-convention files. When present, they are loaded together and read the same way across model integrations. Their rules influence all Upsun Dispatch agents that work with the repository.

| File | Use it for |
| - | - |
| `AGENTS.md` | General repository rules for Upsun Dispatch agents that work with the repository. |
| `CLAUDE.md` | Additional repository rules read together with `AGENTS.md`, regardless of the selected model integration. |
| `REVIEW.md` | Review-specific rules for Code review, such as what to focus on when evaluating a pull or merge request. |

For Code review, Upsun Dispatch reads `REVIEW.md`, `AGENTS.md`, and `CLAUDE.md` from the repository's default branch, not from the pull or merge request head. To change instructions for future reviews, merge the instruction file change to the default branch first.

A file in a nested directory applies to that directory's subtree. When multiple instruction files apply and conflict, the deeper file closest to the changed file wins.

These files complement organization workflow settings and repository overrides. They do not replace settings such as trigger mode, model integration selection, or quality level.

## Where results appear

Each workflow run is visible in the Upsun Dispatch console with status, steps, timeline events, logs, and usage information. Code review also publishes results back to GitHub and GitLab, such as GitHub checks and review comments or GitLab progress notes, commit statuses, and merge request notes.

To inspect a run, follow logs, or rerun an eligible completed, failed, or canceled run, use the Upsun Dispatch console.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.