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

Provide the option to override the commit message #46

Open
cvockrodt opened this issue Jan 13, 2021 · 1 comment
Open

Provide the option to override the commit message #46

cvockrodt opened this issue Jan 13, 2021 · 1 comment

Comments

@cvockrodt
Copy link

cvockrodt commented Jan 13, 2021

Problem

Many CI solutions depend on bump commit messages having a predetermined format, such as bump: version 1.0.0 -> 1.0.1. The commit message for this plugin is simply the new version (i.e. "1.0.1"). Many other semantic-release solutions either already commit in the bump: format, and/or provide a method to override the default functionality.

Potential Solution

Add an additional command line flag such as --commit-message and utilize this option in https://github.com/conveyal/maven-semantic-release/blob/dev/lib/git.js#L103.

Defining Success

Default to or add the ability to override the commit message to a format such as "bump: version 1.0.0 -> 1.0.1"

edit: add description

@v1nc3n4
Copy link

v1nc3n4 commented Jan 5, 2022

Hi,

Thanks for this very helpful plugin! I'd like to provide additional context to the great description given by @cvockrodt.
The commit message as it is actually does not match the conventional commit specification, which makes it incompatible with semantic release, and commit message verification tools such as Husky. Our CI crashes because of this hard-coded message:

[4:29:04 PM] [semantic-release] [@conveyal/maven-semantic-release] › ℹ  committing changes
[4:29:05 PM] [semantic-release] › ✖  An error occurred while running semantic-release: Error: Command failed: git commit -m 0.1.2 [ci skip]
⧗   input: 0.1.2 [ci skip]
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Hope this helps 😃
BR

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

No branches or pull requests

2 participants