-
Notifications
You must be signed in to change notification settings - Fork 22
docs(factories): document integrations and intake #520
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
82cb6ee
docs(factories): document integrations and intake
hongyi-chen 65303e9
docs(factories): replace intake jargon with plain language on connect…
hongyi-chen 0c3ffa0
docs(factories): link provider mentions to their integration guides
hongyi-chen 935a971
docs(factories): Jira work goes to Warp, surfaced through Rovo
hongyi-chen 0cc70f1
docs(factories): de-emphasize Rovo on the connect overview
hongyi-chen eb37158
docs(factories): tighten connect page from review feedback
hongyi-chen b042d59
Merge branch 'hyc/factory-launch' into hyc/factories-connect
hongyi-chen e5bef69
Merge branch 'hyc/factory-launch' into hyc/factories-connect
hongyi-chen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,85 @@ | ||
| --- | ||
| title: Connect your Factory | ||
| title: Connect your factory | ||
| description: >- | ||
| Route work into your Warp Factory from Slack, Linear, GitHub, and local | ||
| coding agents via the Factory MCP. | ||
| Route work into your factory from Slack, GitHub, Linear, Jira, local agents, | ||
| direct runs, and schedules. | ||
| sidebar: | ||
| label: "Connect your Factory" | ||
| label: "Connect your factory" | ||
| --- | ||
|
|
||
| [STUB — pending content from HYC/content team for the 8/18 closed-beta soft launch. Owner: HYC. | ||
| Connect your factory to the tools where your team already discusses, tracks, and reviews work. Wherever work starts, the factory keeps the original context — the thread, issue, or pull request — and posts results back to the same place. | ||
|
|
||
| Lightweight aggregation page — mostly link into existing detailed docs rather than duplicate them. Cover: | ||
| - How work enters a Factory: communication tools (Slack/Teams), task trackers (Linear/Jira), source forges (GitHub/GitLab) | ||
| - The Factory MCP: how any coding agent or MCP client can push work in, pull status, or guide sessions | ||
| - Integration with Warp Terminal and the Warp Agent CLI (native MCP support, local-to-factory handoff) | ||
| - API, SDK, and CLI for building custom integrations (cross-link to the Reference tab) | ||
| ## Choose a source | ||
|
|
||
| Cross-link to the Automation Platform tab's Integrations docs for the underlying connector setup rather than duplicating it.] | ||
| Pick the sources that match where work starts for your team. You can connect more than one. | ||
|
|
||
| | Source | Best for | Where follow-ups continue | | ||
| | --- | --- | --- | | ||
| | [Slack](./integrations/slack) | Chat and support requests | The Slack thread or DM | | ||
| | [GitHub](./integrations/github) | Issues, pull requests, reviews, and CI | The issue, pull request, or review thread | | ||
| | [Linear](./integrations/linear) | Planned issues | The Linear issue and its agent session | | ||
| | [Jira](./integrations/jira) | Work items assigned to Warp | The Jira agent session | | ||
| | [Factory MCP](./factory-mcp) | Sending work from a local coding agent | The factory work item | | ||
| | Direct runs and schedules | One-off or recurring work | The factory work item | | ||
|
|
||
| ## Connect a source | ||
|
|
||
| 1. Pick the factory you want to connect. If you don't have one yet, follow the [Warp Factories quickstart](./quickstart). | ||
| 2. Connect the source: install the provider integration, set up the [Factory MCP](./factory-mcp), or create a schedule. Each integration guide below walks through authorization; grant only the access the factory needs. | ||
| 3. Tell the factory how to respond. Provider connections come with default automations that decide which events start work and which agent handles them; review their filters and run settings. Schedules and direct runs skip this step. | ||
| 4. Send a test request, such as mentioning the factory in Slack or assigning it an issue, and confirm it picks up the work and replies at the source. | ||
|
|
||
| ## How work reaches your factory | ||
|
|
||
| ```mermaid | ||
| flowchart LR | ||
| Event["Event from a<br/>connected tool"] --> Automation["Matching<br/>automation"] | ||
| Schedule["Schedule"] --> Automation | ||
| Automation --> Foreman["Foreman agent"] | ||
| Direct["Direct request"] --> Foreman | ||
| Foreman --> Work["Work item"] | ||
| Work --> Results["Results posted<br/>back to the source"] | ||
| ``` | ||
|
|
||
| An event from a connected tool starts the automation whose filters match it, such as a specific repository, channel, or label. Schedules start their automation on a timer, and direct requests go straight to the factory. | ||
|
|
||
| Every request then lands with the foreman agent, the factory's orchestrator. The foreman turns the request into a work item, works out which stage the work needs next, and dispatches a specialized agent for each stage: triage to scope the request, spec when the design needs agreement, implementation to write the code, and review to check it. Between stages it relays questions and progress back to the source, and it pauses wherever a decision belongs to a human, such as approving a spec or merging a pull request. See [how Warp Factories work](./how-factories-work) for the full lifecycle. | ||
|
|
||
| ## Review the default automations | ||
|
|
||
| When you create a factory through the setup wizard, Warp adds default automations for each tool you connect, so common requests work immediately: | ||
|
|
||
| * **GitHub** - Starts work when the factory is mentioned or assigned, and follows up when pull requests close or merge, completing a linked tracker issue when it can. See the [GitHub integration guide](./integrations/github). | ||
| * **Jira** - Starts work when someone assigns or mentions Warp on a work item in one of the Jira projects you selected. See the [Jira integration guide](./integrations/jira). | ||
| * **Slack** - Starts work from mentions and messages, as described in the [Slack integration guide](./integrations/slack). | ||
|
|
||
| These defaults are starting points. Review each automation's filters, agent, and run settings, and adjust them to match your workflow. | ||
|
|
||
| ## Integration guides | ||
|
|
||
| * [Slack](./integrations/slack) - Route chat requests, direct messages, and thread follow-ups through a dedicated factory app. | ||
| * [GitHub](./integrations/github) - Route repository events with issue, pull request, review, or CI context. | ||
| * [Linear](./integrations/linear) - Route planned issues through issue activity and agent sessions. | ||
| * [Jira](./integrations/jira) - Route Jira work items assigned to Warp into factory work. | ||
|
|
||
| ## Factory MCP | ||
|
|
||
| The Factory MCP connects local coding agents and other MCP clients to your factory. Use it to send work to the factory from your terminal, check status, coordinate with the foreman agent, and hand finished work back to the same work item. See the [Factory MCP guide](./factory-mcp). | ||
|
|
||
| ## Direct runs and schedules | ||
|
|
||
| Not every task starts in an external tool: | ||
|
|
||
| * Start a direct factory run for one-off work: describe the task and the foreman agent takes it from there. | ||
| * Create a scheduled automation for recurring work such as maintenance or reports. | ||
|
|
||
| See the [triggers overview](../platform/triggers/) for how schedules and other triggers work across the platform. | ||
|
|
||
| ## Good to know | ||
|
|
||
| * **Follow-ups continue the same work item** - Replying in the same Slack thread, GitHub issue or pull request, Linear issue, or Jira agent session adds to the existing work item instead of starting a new one. Repeated event deliveries from a provider don't create duplicate work either. | ||
| * **One issue tracker per factory** - A factory can use [Linear](./integrations/linear) or [Jira](./integrations/jira), or no tracker at all, but not both at once. The setup wizard currently offers Linear; to use Jira, connect it after setup or in your [factory definition](./factory-as-code). | ||
| * **Filters route work; they don't restrict access** - Automation filters (repository, channel, team, project, label, author, or status) choose which requests start work. To limit what an integration can reach, change what you authorize for that provider instead. | ||
| * **The factory hands off at the pull request** - It pushes branches and opens pull requests with the repository credentials you configure, and waits for a human to review and merge. Branch protection and required reviews apply as usual. | ||
|
|
||
| Next, customize which agents receive work and how it's routed with [factory definitions as code](./factory-as-code). | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we have a docs page on filters? I think we should
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There wasn't one — filter behavior was spread across the integration pages (matching semantics only on the Linear page, and the routing-vs-access caveat repeated on five pages). Opened #551 to add a dedicated
factories/automation-filterspage consolidating the matching rules, per-source filter availability, the access-boundary statement, and thefilterkey for definitions as code. It's stacked onhyc/factory-launchalongside this PR and links back from the Slack/Jira pages. Once this PR lands, step 3's "review their filters" here can pick up a one-line link to it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah I'm thinking that the filters syntax is useful to explain somewhere specifically (and semantics)