Skip to main content

commit_message_convention

Configuration

name: commit_message_convention
type: string
default: ""
{
"name": "company/project",
"extra": {
"violinist": {
"commit_message_convention": ""
}
}
}

For Violinist to use a commit message convention or not.

Explanation

Violinist has support for using the Conventional Commits commit convention on its commit messages. To use this, set this option to the value conventional. By default it will use no convention, which is the same as settings this value to none.

Example

If you want that Violinist commit messages follow the Conventional Commit, set the value to conventional.

{
"name": "company/project",
"extra": {
"violinist": {
"commit_message_convention": "conventional"
}
}
}

This configuration will allow Violinist to push commit messages like:

build(dev): Update symfony/flex from v1.14.0 to v1.14.1

If you don't want to have formatted commit messages, set it to none or leave it blank.

{
"name": "company/project",
"extra": {
"violinist": {
"commit_message_convention": "none"
}
}
}

This will make Violinist not format its commit messages with any convention. An example message would be:

Update symfony/flex