Skip to content

docs: update factory GitHub mention to @warp #762

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

Open
warp-agent-staging wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update factory GitHub mention to @warp #762

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
2 changes: 1 addition & 1 deletion src/content/docs/factories/connect-your-factory.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once a source is connected, here's the concrete action that hands it work — ea
| Source | Best for | Start work by | Continues in |
| --- | --- | --- | --- |
| [Slack](/factories/integrations/slack/) | Chat and support requests | [Mentioning the app in a channel, thread, or DM](/factories/integrations/slack/#start-and-continue-work-from-slack) | The Slack thread or DM |
| [GitHub](/factories/integrations/github/) | Issues, pull requests, reviews, and CI | [Adding the factory's label and mentioning **@warp-factory**](/factories/integrations/github/#mention-the-factory) | The issue, pull request, or review thread |
| [GitHub](/factories/integrations/github/) | Issues, pull requests, reviews, and CI | [Adding the factory's label and mentioning **@warp**](/factories/integrations/github/#mention-the-factory) | The issue, pull request, or review thread |
| [GitLab](/factories/integrations/gitlab/) | Merge request activity and bot mentions | [Mentioning the factory's bot in a merge request comment](/factories/integrations/gitlab/#mention-the-factory) | The merge request thread |
| [Linear](/factories/integrations/linear/) | Planned issues | [Assigning the issue to the factory, or mentioning the Warp app in a comment](/factories/integrations/linear/#route-agent-sessions) | The Linear issue and its agent session |
| [Jira](/factories/integrations/jira/) | Work items assigned to Warp | [Assigning or mentioning **Warp** on a work item](/factories/integrations/jira/#connect-jira-and-add-an-automation) | The Jira agent session |
Expand Down
12 changes: 6 additions & 6 deletions src/content/docs/factories/integrations/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ When you connect a factory to GitHub, repository activity starts work in your fa

That's all the setup GitHub needs. A new factory arrives with two automations already switched on, so it responds to GitHub activity right away:

* **Mentions and assignments** - Start work by mentioning **@warp-factory**. See [Mention the factory](#mention-the-factory) below.
* **Mentions and assignments** - Start work by mentioning **@warp**. See [Mention the factory](#mention-the-factory) below.
* **Pull request merges** - Close out work by merging a pull request with your factory's label. Any work items linked to the pull request move to their tracker's completed state. Closing without merging does nothing.

To confirm the connection works, mention **@warp-factory** on a test issue and check that a work item starts in the factory's [dashboard](/factories/factory-dashboard/).
To confirm the connection works, mention **@warp** on a test issue and check that a work item starts in the factory's [dashboard](/factories/factory-dashboard/).

## Add a custom automation

Expand Down Expand Up @@ -94,14 +94,14 @@ On check suite and workflow run triggers, **Labels** and **Authors** match the p

## Mention the factory

Add the factory's `factory:<alias>` label to the issue or pull request, then mention **@warp-factory** in the opening body or a new comment. The alias is the **Foreman name** in the factory dashboard's **Identity** settings. Warp creates the label with the factory, and the factory replies in the same thread.
Add the factory's `factory:<alias>` label to the issue or pull request, then mention **@warp** in the opening body or a new comment. The alias is the **Foreman name** in the factory dashboard's **Identity** settings. Warp creates the label with the factory, and the factory replies in the same thread.

{/* VISUAL: An issue with the factory:<alias> label and an @warp-factory mention -- the two-part mention ritual is easy to miss from prose alone. */}
{/* VISUAL: An issue with the factory:<alias> label and an @warp mention -- the two-part mention ritual is easy to miss from prose alone. */}

Without the label, a linked Warp account can still route the mention:

* **One accessible factory** - Warp adds its label and starts work.
* **Multiple accessible factories** - Warp asks you to add the right label and mention **@warp-factory** again.
* **Multiple accessible factories** - Warp asks you to add the right label and mention **@warp** again.
* **No accessible factory** - Warp asks you to connect the repository or request access.

Default automations can respond to authors whose GitHub accounts aren't linked to Warp.
Expand Down Expand Up @@ -137,7 +137,7 @@ These checks validate configuration files only and don't create work items. Unch

### A mention doesn't start work

Confirm the mention is new human-authored content, not an edit, bot comment, or markdown code. Use **@warp-factory**, and add the factory's `factory:<alias>` label. Without a label, routing works only when your linked Warp account can access exactly one factory connected to the repository.
Confirm the mention is new human-authored content, not an edit, bot comment, or markdown code. Use **@warp**, and add the factory's `factory:<alias>` label. Without a label, routing works only when your linked Warp account can access exactly one factory connected to the repository.

If you renamed the alias or changed repositories after creating the factory, the default automation's filters still use the original snapshot. Edit that automation so the label and repository filters match.

Expand Down
Loading