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

docs: improved regex for conventional commit docs #2627

Merged
merged 1 commit into from
Mar 22, 2021

Conversation

roverell
Copy link
Contributor

Recent documentation updated to show how to use GitVersion with Conventional Commit notation has a few gaps. This PR is just an incremental improvement.

Description

  • Updated regex expressions to support more cases.
  • Additional test scenarios to support.

Related Issue

Partial feature implementation discussed in this this PR and this issue (closed)

Motivation and Context

Current docs are incomplete and regex is not consistent with Conventional Commits in some cases.

How Has This Been Tested?

Updated existing tests, replacing with TestCase scenarios for isolation and brevity.
Ran all unit tests in solution successfully.

Screenshots (if appropriate):

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

- Additional test scenarios to support
@roverell
Copy link
Contributor Author

Would we be open to implementing a (new) config option to opt in to various SemVer commit notation schemes? It would be easier for consumers to switch without having to hide their eyes from regex expressions.

If reasonable I could open an issue and potentially look at implementing this.

@asbjornu
Copy link
Member

Would we be open to implementing a (new) config option to opt in to various SemVer commit notation schemes? It would be easier for consumers to switch without having to hide their eyes from regex expressions.

A very closely related where this is being discussed is #2065.

@roverell
Copy link
Contributor Author

Thanks for the quick reply. I think that one is more about the output version syntax, where this is more about the parsing of the commit message. Still, its along the same thought process of widening the use-cases for GitVersion.

@asbjornu asbjornu added this to the 5.6.7 milestone Mar 22, 2021
@asbjornu asbjornu merged commit dc08431 into GitTools:main Mar 22, 2021
@mergify
Copy link
Contributor

mergify bot commented Mar 22, 2021

Thank you @roverell for your contribution!

@arturcic
Copy link
Member

🎉 This issue has been resolved in version 5.6.7 🎉
The release is available on:

Your GitReleaseManager bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants