Skip to content

README.md

Latest commit

 

History

History
84 lines (54 loc) · 1.91 KB

README.md

File metadata and controls

84 lines (54 loc) · 1.91 KB

Conventional Commits for Java

Provides a Java implementation of Conventional Commits for projects built with Java 1.8+ using Git for version control.

Maven Plugin

Usage

This plugin works together with the Maven Release Plugin to create conventional commit compliant releases for your Maven projects

Install the Plugin

In your main pom.xml file add the plugin:

    <plugins>
        <plugin>
            <groupId>com.smartling.cc4j</groupId>
            <artifactId>conventional-commits-maven-plugin</artifactId>
            <version>${version}</version>
        </plugin>

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-release-plugin</artifactId>
            <version>3.0.0-M5</version>
            <configuration>
                <scmCommentPrefix>build(release): </scmCommentPrefix>
                <scmDevelopmentCommitComment>ci(release): open next snapshot version</scmDevelopmentCommitComment>
                <scmReleaseCommitComment>build(release): publish</scmReleaseCommitComment>
            </configuration>
        </plugin>
    </plugins>

In your CI code:

  • Execute only for master|main branch
  • skip builds for build(release) and ci(release) commits

GitHub workflow:

jobs:
  main:
    ...
    if: |
      "!contains(github.event.head_commit.message, 'build(release)')" &&
      "!contains(github.event.head_commit.message, 'ci(release)')"

Gitlab:

  only:
    variables:
      - '$CI_COMMIT_MESSAGE !~ /^(build|ci)\(release\):.+/'
      - '$CI_COMMIT_BRANCH =~ /^(master|main)/'

Release a Version

mvn conventional-commits:version release:prepare
mvn release:perform

Gradle Plugin

A [Gradle] plugin is planned for future release.