Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add JIRA issues parsing #96

Closed
wants to merge 1 commit into from

Conversation

TheoGoudout
Copy link
Contributor

When a JIRA issue is referenced in a commit, it is now possible to parse it. The JIRA issues will then be added to a dedicated section for each version.

When a JIRA issue is referenced in a commit, it is now possible to
parse it. The JIRA issues will then be added to a dedicated section
for each version.
@pawamoy
Copy link
Owner

pawamoy commented Jan 3, 2025

Hi @TheoGoudout, thanks for the pull request 🙂

It's usually better to first open a new issue/discussion before a PR. I'm not a fan of how Jira support is "hardwired" into the code base. I don't think I'll want to maintain that 😕 I would have preferred an implementation based on ProviderRefParser, which I would have pointed you to in a discussion 😄

Also, are you aware we support Git trailers, which can be used to reference anything?

feat: Some new feature

Jira-123: https://link.to/jira/123

Such trailers are rendered in the changelog too: [Jira-123](https://link.to/jira/123) -> Jira-123.

@TheoGoudout
Copy link
Contributor Author

You are right, I should have open an issue. I'll try and have a look at how to do it with ProviderRefParser.

I've seen that you support Git trailers but unfortunately, I don't think it would work with the way we do things in my workplace. Thanks, though.

You can close this PR if you want. I'll re-open one if I have enough time to do it yhe proper way.

@pawamoy
Copy link
Owner

pawamoy commented Jan 3, 2025

Alright, thanks for your understanding!

It's very possible that ProviderRefParser is not flexible enough, since one can actually use Jira+GitHub, or Jira+GitLab, etc., so we'll have to discuss how to make it more flexible to allow combos (the class itself and its implementations, or how they're used higher up in the stack).

Quick note: another approach would be to allow users to hook into the parsing process, to augment commit data with their own logic. Worth discussing too.

@pawamoy pawamoy closed this Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants