Include ticket numbers

[RWOverdijk]

Hey!

I have been using this for about 10 months now and it's excellent. Right now there's a bit of a shift in how we do things and I risk losing access to cliff unless I find a solution.

We have to include some reference to our tickets (jira) in the changelog.

The way I solved this link before this change was by working on branches with the ticket number in it: feature/XXX-000000-description. This made it very easy for me to find the ticket number for a commit.

But this should be part of the changelog entry now, so I was thinking about maybe a format like this:

(project) [breaking] Gorgeous message here - ([123456](https://repo-url.com/hash/123456) by John, [XXX-000000](https://jira-url.com/XXX-000000))

Is there any way in which cliff could help with this? I've been thinking about it, and I can't figure out the nicest way of doing this. I do understand that it's nice to be able to link a commit to a ticket, so it's easier to open the ticket and get more context.

I don't know if this is even possible, but I had to ask 😅 Thank you for reading!

[ognis1205]

Hi @RWOverdijk ,

https://git-cliff.org/docs/configuration/git/#link_parsers

Wouldn’t it be possible to use a link_parser like this?

# An array of link parsers for extracting external references, and turning them into URLs, using regex.
link_parsers = [
    { pattern = "JIRA\\(([A-Z]+-\\d+)\\)", text = "$1", href = "https://jira-url.com/$1" },
]

That way, if the commit message contains something like JIRA(XXX-000000), it should be included in commit.links and automatically linked in the changelog. Am I missing something here?

[RWOverdijk]

That is probably it! I must've read over it. Thank you