Ticket Extraction

Shipi can extract ticket references from your commits and include them in the release notes.

Enable ticket extraction

shipi generate --tickets

Supported formats

Shipi recognizes these ticket patterns:

Example

Given these commits:

feat: add dark mode toggle [FEAT-892]
fix: resolve login bug (#421)
perf: optimize search queries [PERF-201]

Running:

shipi generate --tickets --audience changelog

Output:

## v2.4.0

- Added dark mode toggle in settings [FEAT-892]
- Search results now load 2x faster [PERF-201]
- Fixed Safari login redirect bug [#421]

Link tickets to URLs

Configure ticket URLs in shipi.json:

{
  "tickets": {
    "jira": "https://yourcompany.atlassian.net/browse/",
    "github": "https://github.com/yourorg/yourrepo/issues/"
  }
}

Filter by ticket prefix

Only include changes with specific ticket prefixes:

shipi generate --tickets --ticket-prefix FEAT,BUG