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 post-body jiraLocation #67

Closed

Conversation

Phil-Barber
Copy link

This comes with a bit of complexity. Previously we were automatically appending a space to the jira
part. However by moving it here, we actually wish to have the space at the start. This then adds
complications with the jiraPrepend and jiraAppend options, and thus causes a breaking change.

BREAKING CHANGE: Existing jiraAppend options will need to add an extra space to maintain
functionality

This comes with a bit of complexity. Previously we were automatically appending a space to the jira
part. However by moving it here, we actually wish to have the space at the start. This then adds
complications with the jiraPrepend and jiraAppend options, and thus causes a breaking change.

BREAKING CHANGE: Existing jiraAppend options will need to add an extra space to maintain
functionality
@juliuscc
Copy link
Collaborator

Hi! Thanks for contributing to this project. This seems very complicated and I am don't fully understand the changes. I am concerned about breaking changes without understanding if it's a feature or it's a preference.

There has been a discussion in issue #68 that is very relevant to this. Especially this paragraph:

TBH I think we are starting to get more and more complicated requests, that muddle up the API little by little. I would prefer advanced users to have a templating option. Probably something based on mustache or something else lightweight.

What do you think about adding full templating support instead? The idea is that you would be able to determine the structure of the commit like this:

module.exports = {
  template: "{{type}}{{scope}} {{jiraIssueWithBrackets}}: subject\n\n{{body}}\n\n{{breakingChanges}}\n\n[{{jiraIssue}}](https://company.jira.com/issues/{{jiraIssue}})"
}

Which would result in something like this:

feat(server) [AB-1234]: added endpoint

I added an endpoint

[AB-1234](https://company.jira.com/issues/AB-1234)

@Phil-Barber
Copy link
Author

Yes that templating is significantly nicer! I'll try and look into it at some point 👍

@juliuscc
Copy link
Collaborator

Great! Thanks! 😁

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