riff

    The app

    Jira tickets

    Where a PR's Jira ticket shows up in the PR list and on the PR page, and how riff finds it.

    With a Jira connection set up, riff shows each PR’s ticket next to it: in the PR list, in the open-PR tabs and on the PR page. riff only reads from Jira; it never changes a ticket. Set up a connection in Settings → Jira, or see Jira.

    How riff finds the ticket

    riff looks for a ticket key (such as WEB-2204) in the PR’s branch name and title. A key in square brackets at the start of the title ([WEB-2204] Fix the night boundary) is shown as a chip instead of as part of the title. When the connection lists project keys, only keys from those projects count.

    Each repository uses the connection whose Repositories include it. Tickets are saved and asked for again after about ten minutes; Refresh asks right away.

    In the PR list

    • Ticket on each row. The row’s meta line shows the key, a dot in the status category’s colour (to do, in progress, done), the status, and the assignee when it isn’t the PR’s author. Hover the key for the ticket’s summary.
    • Filter by ticket. The filter matches ticket keys as well as titles, numbers, repositories, authors and branches.
    • Group by epic or team. Group by → Epic lists each epic’s PRs in the order they have to merge, from stacked base branches and Jira “blocks” links. Group by → Team groups by the ticket’s Jira team, yours first. PRs without a ticket fall into “No epic” or “No team”. See Stacks and dependencies.
    • Setup notice. When a connection has no token, or Jira rejects it, the list says so above the rows.

    On the PR page

    The Jira card

    The details column has a Jira card:

    • the key (a link to the ticket) and its status;
    • the summary, the issue type, the assignee, and the epic or parent;
    • the ticket’s links, each with its PR and stage: Blocked by, Blocks, Same stack and Relates to;
    • the ticket’s Acceptance criteria, Description and Testing sections, as formatted text.

    At narrower widths the ticket is a single line above the status, with a Details button for the full card. When the ticket can’t be read, the card says why: no connection for this repository, no token, a rejected token, or a key Jira doesn’t know.

    Dependency gates

    When the ticket has links, the merge status gains up to three gates:

    Gate Shows
    Depends Whether the tickets this one is blocked by have shipped. Holds the merge while any has not.
    Order The PR is a stack layer and merges after the layer below it.
    Unblocks Tickets that wait on this one.

    Merge guard

    Merging a PR whose ticket is blocked by tickets that haven’t shipped asks first and lists the blockers. You can merge anyway. The check reads Jira at the moment you merge; if Jira can’t be reached, the merge goes ahead. riff pr merge applies the same guard and stops with exit code 6 unless you pass --ignore-deps.

    Elsewhere

    • The agent reads the PR’s ticket along with the change, so you can ask whether the change covers the acceptance criteria.
    • riff pr status and riff pr inbox --group epic|team print the same ticket data in the terminal. See riff pr.