Ticket IDs
Add PROJ-123 from your branch name to every message.
Working on feat/PROJ-123-login? gitmit can add PROJ-123 to every message:
{ "ticket": { "position": "suffix" } }
position | Result |
|---|---|
"suffix" (default) | feat(auth): add login form (PROJ-123) |
"prefix" | feat(auth): PROJ-123 add login form |
"footer" | feat(auth): add login form with a Refs: PROJ-123 trailer |
- Pattern: by default, gitmit looks for IDs like
ABC-123(([A-Z][A-Z0-9]+-\d+)). Set your own withfromBranch, a regular expression whose first capture group is the ID. For example,"^gh-(\\d+)"takes1234fromgh-1234/fix-thing. - Required tickets: with
"required": true, gitmit refuses to commit on a branch without a ticket ID. - Length: the ticket counts toward
subjectMaxLength, and the model is told how much room is left. - No duplicates: an ID the description already mentions isn't added twice.