Connect Jira
Connect a Jira site so missions can start from a ticket and report back on it.
Overview
Jira is one place where a project's work can be planned. When you connect a Jira site, SHIP becomes an agent that your team can assign tickets to. The mission starts from the ticket and reports its progress there. A Jira site admin installs the SHIP app once, and the people who file the work install nothing.
Jira is optional. A project can use Linear or GitHub Issues instead. It can also use no tracker at all and take its work from the terminal. See hand-off options.
Steps
Install the SHIP app
A Jira site admin installs the SHIP app on the Jira site. To get the app, contact SHIP support.
Connect the site to your organization
In Jira, open Apps, then SHIP, and select Connect to SHIP. A SHIP page opens. Sign in to SHIP. Check that the page shows the correct Jira site. Select the organization. Then select Connect Jira.
The link works once and expires 10 minutes after Jira makes it. If it expires, select Connect to SHIP in Jira again. You need a role that can change the configuration of the organization. A Jira site connects to one SHIP organization only.
You can also connect from the terminal. Copy the code after code= in the link. Then give the code to ship connect jira.
Pick the Jira project
On the Project step of onboarding, choose Jira as the place where this project's work is planned. Then select the Jira site and the Jira project. The Jira choice shows only after you connect a site.
To move a project that you already have to Jira, open Projects in the console. Select Edit on the project. Choose Jira, then select the Jira project. SHIP refuses the change while a mission of the project runs.
Start a mission
Assign the ticket to SHIP, or mention @SHIP in a comment on the ticket.
The ticket's agent panel shows SHIP as busy for the whole mission, and the label names the stage of the mission. Open the entry to see each step of the mission. When the pull request is ready to merge, the entry finishes and shows that result.
SHIP also keeps one comment on the ticket. That comment gets the plan, the review verdict, the test result and the pull request link at each stage. The SHIP panel on the ticket has an Inspect on SHIP link. When the mission opens the pull request and the preview, the panel gets a link to each.
SHIP moves the ticket to In Progress, In Review and Done as the mission goes on. If your workflow has no status with that name, SHIP uses a status in the same category.
A ticket that is good enough for a person is usually good enough for an agent. It says what you want and how you will know that it is done. QA verifies against the acceptance criteria that you write, so make those criteria specific.
Give a mission more instructions
Mention @SHIP in a comment on the ticket. The agents take the instruction and continue on the mission's open pull request.
You can also open a new chat with SHIP in Rovo. Start the message with the ticket key, for example KAN-12 also add a test. A chat message does not include the ticket that Rovo shows next to it. If the message names no ticket, SHIP asks for the key. Rovo does not let you send a message in a conversation while SHIP is busy in it, so use a new chat.
@SHIP pause, @SHIP resume and @SHIP stop control the mission. The console detail page has the same three controls as buttons. If a mission escalates for attention, restart it from that page.
Troubleshooting
SHIP says that the Jira site is not connected
A Jira admin connects the site in Jira: open Apps, then SHIP, and select Connect to SHIP. The same page shows which SHIP organization the site sends its tickets to.
SHIP says that the Jira project is not connected to a SHIP project
Create a project in the SHIP console, and select this Jira project as its tracker. Keep one SHIP project for each Jira project, because SHIP refuses a Jira project that two SHIP projects use.
The ticket status does not change
SHIP moves a ticket only through a transition that your Jira workflow has. If no transition goes to the status or to its category, the status stays as it is.
SHIP asks you to reinstall the app
Someone uninstalled the SHIP app from the Jira site. Install it again. The new installation connects the site to the same organization again.
Disconnect a site
In Jira, open Apps, then SHIP, and select Disconnect from SHIP. SHIP then starts no missions from that site.
How is this page?