maven-git-versioning-extension

Features

• add additional version component placeholders (#165 @pdkyas)

Fixes

• fix worktree handling

Features

• Add <relatedProjects> config option

Fixes

• fix rootDirectory determination for sub working trees

7.1.2

Fixes

• proper handle of concurrent module builds

Fixes

• if a tag is provided (and no branch) the extension behaves like in detached head state
• if a branch is provided (and no tag) the extension behaves like in attached head state with no tags pointing to head

Features

• New Placeholder ${commit.timestamp.year.2digit}

Features

• Add GitHub Actions, GitLab CI and Jenkins environment variable support

  • GitHub Actions: if $GITHUB_ACTIONS == true, GITHUB_REF is considered
  • GitLab CI: if $GITLAB_CI == true, CI_COMMIT_BRANCH and CI_COMMIT_TAG are considered
  • Circle CI: if $CIRCLECI == true, CIRCLE_BRANCH and CIRCLE_TAG are considered
  • Jenkins: if JENKINS_HOME is set, BRANCH_NAME and TAG_NAME are considered

• Simplify xml configuration (also see BREAKING CHANGES)

  Example: maven-git-versioning-extension.xml

  <configuration xmlns="https://github.com/qoomon/maven-git-versioning-extension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://github.com/qoomon/maven-git-versioning-extension https://qoomon.github.io/maven-git-versioning-extension/configuration-7.0.0.xsd">
  
      <refs>
          <ref type="branch">
              <pattern>.+</pattern>
              <version>${ref}-SNAPSHOT</version>
              <properties>
                  <foo>${ref}</foo>
              </properties>
          </ref>
  
          <ref type="tag">
              <pattern><![CDATA[v(?<version>.*)]]></pattern>
              <version>${ref.version}</version>
          </ref>
      </refs>
  
      <!-- optional fallback configuration in case of no matching ref configuration-->
      <rev>
          <version>${commit}</version>
      </rev>
  
  </configuration>
  

• New option to consider tag configs on branches (attached HEAD), enabled by <refs considerTagsOnBranches="true">

  • If enabled, first matching branch or tag config will be used for versioning

• prevent unnecessary updates of pom.xml to prevent unwanted rebuilds (#129 kudos to @ls-urs-keller)

BREAKING CHANGES

• There is no default config anymore, if no <ref> configuration is matching current git situation and no <rev> configuration has been
  defined a warning message will be logged and extension will be skipped.
• Placeholder Changes (old -> new)
  • ${branch} -> ${ref}
  • ${tag} -> ${ref}
  • ${REF_PATTERN_GROUP} -> ${ref.REF_PATTERN_GROUP}
  • ${describe.TAG_PATTERN_GROUP} -> ${describe.tag.TAG_PATTERN_GROUP}
• preferTags option was removed
  • use <refs considerTagsOnBranches="true"> instead

• Features

  • add git describe version placeholders
    • new placeholders
      • ${describe}
      • ${describe.tag}
        • ${describe.<TAG_PATTERN_GROUP_NAME or TAG_PATTERN_GROUP_INDEX>} e.g. pattern v(?<version>.*) will create placeholder ${describe.version}
      • ${describe.distance}

• BREAKING CHANGES

  • no longer provide project property git.dirty due to performance issues on larger projects,
    version format placeholder ${dirty} is still available

Fix parent project handling

• Fixes
  • Handle xsi:schemaLocation property in configuration file

Improve logs

feat: support for environment variables in version formats

Bugfixes

• handle ambiguous dependencies #96

• Features
  • add ability to define default or overwrite values for version and property format.
    • default value if parameter value is not set ${paramter:-<DEFAULT_VALUE>} e.g. ${buildNumber:-0}
    • overwrite value if parameter has a value ${paramter:+<OVERWRITE_VALUE>} e.g. ${dirty:+-SNAPSHOT}

5.0.0

Features

• simplify <property> replacement configuration

Fixes

• add missing dependency vor maven version 3.3

Breaking Changes

• simplify <property> replacement configuration

  new config

  <gitVersioning>
      <branch>
          <pattern>master</pattern>
          <versionFormat>${version}</versionFormat>
          <property>
              <pattern>revision</pattern>
              <valueFormat>${branch-SNAPSHOT}</valueFormat>
          </property>
      </branch>
  </gitVersioning>
  

  old config

  <gitVersioning>
      <branch>
          <pattern>master</pattern>
          <versionFormat>${version}</versionFormat>
          <property>
              <pattern>revision</pattern>
              <value>
                  <format>${branch-SNAPSHOT}</format>
              </value>
          </property>
      </branch>
  </gitVersioning>
  

• restrict project versioning to root- and sub-projects
• fix verbose logging when disabling extension by flag