Jira

Jira is optional. Once it's connected:

• links to tickets on your Jira site open in a ticket tab in Revue instead of the browser;
• ticket keys like ABC-123 become links everywhere: pull request titles, branch names, commit messages and comments;
• you can comment, move a ticket along its workflow and assign it to yourself without leaving Revue;
• the Projects page shows your Jira projects with their repositories.

Revue works with Jira Cloud sites (your-company.atlassian.net). You can connect several sites, or several people on one site.

Connect Jira#

1. On the welcome screen click Jira, or in Settings → Accounts click Connect Jira (Add Jira account once one is connected).
2. Click Sign in with Atlassian. A tab opens on Atlassian.
3. Sign in there if it asks.
4. Under Use app on, pick your Jira site, then click Accept.
5. Come back to Revue. It connects by itself.

If your Atlassian account reaches several Jira sites, Revue asks Your Atlassian account reaches several Jira sites. Which one? Click one. To connect another site later, sign in again.

Guide: Connect Jira with an API token#

1. Click Advanced: use a token instead under Sign in with Atlassian.
2. Click Create token. Atlassian's API tokens page opens.
3. Choose Create API token with scopes, pick the app Jira, and give it the scopes below.
4. Copy the token.
5. In Revue, type your site's address (https://your-company.atlassian.net), your Atlassian account email, and paste the token.
6. Click Connect Jira.

If you connected Bitbucket first, the email is already filled in: it's usually the same Atlassian account.

Ticket tabs#

Click a link to a ticket on a connected site, or a ticket key anywhere in Revue, and the ticket opens in a tab. The tab sits in the same group as the pull request you clicked it in, and closing that pull request closes its tickets too.

At the top you see the ticket's key and summary, its type (Story, Bug…), and two buttons: Reload and Open in Jira.

The details#

Below the status, the ticket shows whatever it has of:

Then the Description, and the Comments, newest first. Links and ticket keys in them open in Revue too.

Change the status#

1. Click the status button (for example IN PROGRESS).
2. Under Move to, pick where the ticket goes. You see exactly the transitions Jira offers from the current status.
3. Confirm with Move.

When the status has no transitions, the button says so (No transitions from this status).

Assign it to yourself#

1. Click the ⋯ (More) button next to the status.
2. Click Assign to me (or Unassign when it's yours).
3. Confirm with Assign (or Unassign).

The same menu has Open in Jira, Copy link and Copy key.

Comment#

Type in Add a comment… (Markdown) under Comments and click Comment. You write Markdown; Revue turns it into Jira's own format. The usual formatting shortcuts work, such as Ctrl+B for bold (Cmd+B on macOS).

Ticket keys become links#

Once Jira is connected, Revue knows your site's project keys. A key of one of those projects (ABC-123) becomes a link to the ticket everywhere: pull request titles, branch names, commit messages and comments. You don't have to set anything up.

For keys of other trackers, or to link a repository's keys to a particular site, add ticket link rules to the repository: Settings, the repository's page, Ticket links for …. Add Jira projects fills in rules for the projects you list. Those rules are checked before Jira's. See Settings reference.

Advanced: how link rules work

• A rule has a key prefix (ABC-) and the address it opens, with <num> for the number or <key> for the whole key, for example https://acme.atlassian.net/browse/ABC-<num>.
• The prefix * matches any key that looks like a Jira key.
• Add Jira projects asks for the site and the project keys (ABC, OPS). With no keys, it adds one * rule for the site.
• A key that two connected sites both have links to the site added first.

Tickets when you open a pull request#

The Open pull request form has a Ticket (optional) field:

• Revue fills it in for you when the branch's last commit or its name has a ticket key (feature/ABC-123-docs), and puts the key at the start of the title.
• Click the field to see Your open tickets, or type to Search Jira, or type a key (ABC-123). It searches every connected Jira account.
• Click the ticket chip to change it, or × for No ticket.

The ticket is used in the Slack announcement of the new pull request (see Slack). See Opening a pull request for the rest of the form.

Advanced: how the branch's ticket is found

Revue looks, in order, for a ticket key in:

1. the subject of the branch's last commit,
2. the branch name as written (ABC-123),
3. the branch name in capitals, but only for a project Revue knows (from your Jira sites and link rules), so feature/abc-123-docs finds ABC-123 while fix/antd-5 finds nothing.

Without Jira connected, the field still takes a key typed whole. A key no link rule covers says No link rule covers this key.

The Projects page#

With Jira connected, a Projects button joins Repositories at the top of the window (Ctrl+J, Cmd+J on macOS). It lists each Jira account's projects, with the repositories under each. Click a repository to open it.

A repository shows under a project when:

• it's in the Bitbucket project of that key, or
• its ticket link rules link the project's keys (link rule), or
• its open pull requests mention the project's tickets (from PRs).

All options on the Projects page

• Filter projects and repositories… at the top (Ctrl+F or /).
• Favorites: starred projects, every Jira account's. Press f to star the selected project; on the Favorites tab, Alt+↑ / Alt+↓ moves it.
• Hide empty projects, Fold all projects, Unfold all projects and Refresh in the header.
• ↑ ↓ or j k select, Enter opens or folds.
• Open in Jira on a project opens its page on the site.

Sign out of Jira#

1. Open Settings → Accounts.
2. Click Sign out on the Jira account's row.
3. Confirm with Sign out.

Revue forgets the account, and links to that site open in the browser again. When a Jira sign-in expires, Revue says so and offers Sign in again: see Accounts and signing in.