Is there a way to include Jira style prefix at the front of the message? about semantic-pull-requests

[stefanbuck]

I'm currently working on a GitHub app which might be interesting for you @josh803316. It automatically adds a badge to the Pull Requests description that links to the related JIRA ticket.

The app is in private beta right now. Please drop me a DM if you want to join the beta group

https://twitter.com/buckstefan/status/1147620338584473602

[zeke]

I would prefer to keep this bot as agnostic as possible about commit conventions, deferring to an existing parser (currently parse-commit-message) that implements the Conventional Commits spec.

That said, maybe there's a case for trying to add something like this to the spec. Do you know of tools other than Jira that use this style?

[josh803316]

@zeke Thanks for the response! Some people actually use the following format for issues that have been opened on Github repos:

[FIXES-123] or [FIX-123] ... and some do it without the brackets. It would be cool to simply add an optional prefix, although I totally understand your desire to keep the bot as agnostic as possible. Worse case I guess we could try to open a PR, if we knew where to look.

[nesl247]

I was actually about to open up an issue when I saw this. Having support for this exact thing would be really beneficial.

One other exception that would be beneficial (if not already supported) is to not fail on would be a WIP, WIP:, [WIP] prefix as is used with many WIP bots.

[damusnet]

Same thing here, a regular commit / PR will look like this where I work:
WR-13: fix(Sidebar): update font-family and letter-spacing
Adding the WR-13 allows us to link Jira tickets with GitHub PR and track them to completion.

IIUC semantic-pull-requests uses parse-commit-message which doesn't validate against such a prefix by default. It does however seem to support plugins to extend it. Not sure how it would be possible to pass a config from a repo to semantic-pull-requests to parse-commit-message though 🤔

[markcellus]

I would prefer to keep this bot as agnostic as possible about commit conventions, deferring to an existing parser (currently parse-commit-message) that implements the Conventional Commits spec.

@zeke but it appears the tool isn't actually agnostic to the commit conventions though. It actually is opinionated about the type of commit conventions because it requires the style of conventional commits. :) Is there a way you would recommend to have a custom validation git commit messages that are not conventional commits?

[tunnckoCore]

@damusnet, parse-commit-message supports plugins (at least since v3, not sure what was the version when you commented), but I believe, it was always supporting plugins. Anyway.

@zeke could allow extending it through the semantic-pull-requests config. Or passing different regex to the parser. I'l think of something after the v4 release.

Overall, yea, semantic-pull-requests is meant to be following the conventional commits (i guess all this came from Angular and Semantic Release) and that's why it's called that way. But yea, it's not a problem to extend it. I'm open for the parse-commit-message too, since it's name is even more general.

I'm trying to find from where I published latest v4 canary (.20) version, dang... 🤕 I believe I published it from somewhere in speed to fix this bot :D Aaaaaaaanyway.

[tunnckoCore]

some wanting this can try implement it with latest canary (canary-20200142.1) of the parser. hint: pass options.headerRegex

[tunnckoCore]

4.0.0-canary.20200124.2 (parse-commit-message@canary) has full-blown documentation ;p Only more tests left.

[zeke]

This issue is old and inactive so I'm going to close it. If anyone is still affected by this, let me know and I'll re-open it.