Skip to content

Releases: git-commit-id/git-commit-id-plugin-core

Version 6.0.0-rc.8

09 Mar 15:14
Compare
Choose a tag to compare

Version 6.0.0-rc.8 is finally there and includes various bug-fixes and improvements.
Note that this library was previously part of the git-commit-id-maven-plugin so you might want relevant changes in the issues listed there too :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully. As of now this is only a release candidate. Future release candidates and the final 6.0.0 version may contain further breaking changes ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version:

New Features / Bug-Fixes:

The main key-aspects that have been improved or being worked on are the following:

Getting the latest release

The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:

<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-plugin-core</artifactId>
    <version>6.0.0-rc.8</version>
</dependency>

Getting the latest snapshot (build automatically)

If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by github actions:

<pluginRepositories>
    <pluginRepository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </pluginRepository>
</pluginRepositories>

Even though the github actions will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.

Known Issues / Limitations:

  • N/A

Reporting Problems

If you find any problem with this plugin, feel free to report it here

Version 6.0.0-rc.7

04 Mar 21:13
Compare
Choose a tag to compare
Version 6.0.0-rc.7 Pre-release
Pre-release

Version 6.0.0-rc.7 is finally there and includes various bug-fixes and improvements.
Note that this library was previously part of the git-commit-id-maven-plugin so you might want relevant changes in the issues listed there too :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully. As of now this is only a release candidate. Future release candidates and the final 6.0.0 version may contain further breaking changes ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version:

New Features / Bug-Fixes:

The main key-aspects that have been improved or being worked on are the following:

  • #72: add git.tag to get the tag on a certain commit

  • #102: Improve tests

  • #103: Fix commit.committer.time provider

  • #106 / git-commit-id/git-commit-id-maven-plugin#701: Fix an issue where running with submodules using the native git executable was causing a fatal: this operation must be run in a work tree

  • #101: Move process output handling to separate class & add tests

  • bump several maven plugins

    • bump org.apache.maven.plugins:maven-clean-plugin from 3.3.1 to 3.3.2
    • bump org.apache.maven.plugins:maven-checkstyle-plugin from 3.3.0 to 3.3.1
    • bump org.apache.maven.plugins:maven-surefire-plugin from 3.1.2 to 3.2.5
    • bump org.apache.maven.plugins:maven-dependency-plugin from 3.6.0 to 3.6.1
    • bump org.apache.maven.plugins:maven-javadoc-plugin from 3.6.0 to 3.6.3
    • bump org.codehaus.mojo:exec-maven-plugin from 1.3 to 3.1.1
    • bump org.codehaus.mojo:exec-maven-plugin from 3.1.1 to 3.2.0
    • bump org.jacoco:jacoco-maven-plugin from 0.8.2 to 0.8.11
    • bump org.apache.maven.plugins:maven-compiler-plugin from 3.11.0 to 3.12.1
  • bump several dependencies

    • bump org.eclipse.parsson:parsson from 1.1.4 to 1.1.5
    • bump org.mockito:mockito-core from 5.6.0 to 5.10.0
    • bump commons-io:commons-io from 2.14.0 to 2.15.1
    • bump jgit.version from 6.7.0.202309050840-r to 6.8.0.202311291450-r
    • bump jakarta.json:jakarta.json-api from 2.1.2 to 2.1.3
    • bump org.yaml:snakeyaml from 2.0 to 2.2
    • bump org.assertj:assertj-core from 3.24.2 to 3.25.3
    • bump org.slf4j:slf4j-simple from 2.0.9 to 2.0.12
    • bump joda-time:joda-time from 2.12.5 to 2.12.7
    • bump actions/setup-java from 3 to 4
    • bump actions/cache from 3 to 4

Getting the latest release

The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:

<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-plugin-core</artifactId>
    <version>6.0.0-rc.7</version>
</dependency>

Getting the latest snapshot (build automatically)

If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by github actions:

<pluginRepositories>
    <pluginRepository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </pluginRepository>
</pluginRepositories>

Even though the github actions will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.

Known Issues / Limitations:

  • N/A

Reporting Problems

If you find any problem with this plugin, feel free to report it here

Version 6.0.0-rc.6

21 Oct 07:55
Compare
Choose a tag to compare
Version 6.0.0-rc.6 Pre-release
Pre-release

Version 6.0.0-rc.6 is finally there and includes various bug-fixes and improvements.
Note that this library was previously part of the git-commit-id-maven-plugin so you might want relevant changes in the issues listed there too :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully. As of now this is only a release candidate. Future release candidates and the final 6.0.0 version may contain further breaking changes ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version:

  • #57: Stop relying on javax.json 1.1.4
    • the dependency for javax.json:javax.json-api:1.1.4 was replaced with jakarta.json:jakarta.json-api:2.1.2
    • the dependency for org.glassfish:javax.json:1.1.4 was replaced with org.eclipse.parsson:parsson:1.1.4

New Features / Bug-Fixes:

The main key-aspects that have been improved or being worked on are the following:

  • git-commit-id/git-commit-id-maven-plugin#624: downgrade some log messages from info to debug; Jgit is way chattier than the native git implementation, by downgrading we somewhat make them more equal
  • Update various versions
    • bump jgit from 6.5.0.202303070854-r to 6.7.0.202309050840-r
    • bump commons-io:commons-io from 2.11.0 to 2.14.0
    • bump org.slf4j:slf4j-simple from 2.0.7 to 2.0.9
    • Maven related versions
      • bump maven-assembly-plugin from 3.5.0 to 3.6.0
      • bump maven-dependency-plugin from 3.5.0 to 3.6.0
      • bump maven-release-plugin from 3.0.0-M7 to 3.0.1
      • bump maven-enforcer-plugin from 3.3.0 to 3.4.1
      • bump maven-compiler-plugin from 3.10.1 to 3.11.0
      • bump maven-gpg-plugin from 3.0.1 to 3.1.0
      • bump maven-clean-plugin from 3.2.0 to 3.3.1
      • bump maven-surefire-plugin from 2.22.2 to 3.1.2
      • bump maven-install-plugin from 3.1.0 to 3.1.1
      • bump maven-deploy-plugin from 3.1.0 to 3.1.1
      • bump maven-javadoc-plugin from 3.4.1 to 3.6.0
      • bump maven-source-plugin from 3.2.1 to 3.3.0

Getting the latest release

The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:

<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-plugin-core</artifactId>
    <version>6.0.0-rc.6</version>
</dependency>

Getting the latest snapshot (build automatically)

If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by github actions:

<pluginRepositories>
    <pluginRepository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </pluginRepository>
</pluginRepositories>

Even though the github actions will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.

Known Issues / Limitations:

  • N/A

Reporting Problems

If you find any problem with this plugin, feel free to report it here

Version 6.0.0-rc.5

16 May 18:47
Compare
Choose a tag to compare
Version 6.0.0-rc.5 Pre-release
Pre-release

Version 6.0.0-rc.5 is finally there and includes various bug-fixes and improvements.
Note that this library was previously part of the git-commit-id-maven-plugin so you might want relevant changes in the issues listed there too :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully. As of now this is only a release candidate. Future release candidates and the final 6.0.0 version may contain further breaking changes ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version:

  • Made the dump and read methods in all the non generic file manager protected (from public)
    • E.g. a dumpJson or readJsonProperties in JsonManager is now protected instead of pulic, use the GenericFileManager instead

New Features / Bug-Fixes:

The main key-aspects that have been improved or being worked on are the following:

  • modernized the issue templates
  • added tests for java 11 - java 20
  • introduced a GenericFileManager that allows to read / write properties in all formats (properties, json, xml, yml, ...)

Getting the latest release

The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:

<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-plugin-core</artifactId>
    <version>6.0.0-rc.5</version>
</dependency>

Getting the latest snapshot (build automatically)

If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by github actions:

<pluginRepositories>
    <pluginRepository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </pluginRepository>
</pluginRepositories>

Even though the github actions will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.

Known Issues / Limitations:

  • N/A

Reporting Problems

If you find any problem with this plugin, feel free to report it here

Version 6.0.0-rc.4

16 May 18:42
Compare
Choose a tag to compare
Version 6.0.0-rc.4 Pre-release
Pre-release

Version 6.0.0-rc.4 is finally there and includes various bug-fixes and improvements.
Note that this library was previously part of the git-commit-id-maven-plugin so you might want relevant changes in the issues listed there too :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully. As of now this is only a release candidate. Future release candidates and the final 6.0.0 version may contain further breaking changes ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version:

  • None

New Features / Bug-Fixes:

The main key-aspects that have been improved or being worked on are the following:

  • #18: added org.yaml:snakeyaml version 2.0 so the core plugin can generate YML output files
  • #18: added the ability to generate XML output files
  • Instead of validating the allowedCharactersForEvaluateOnCommit in the git-commit-id-maven-plugin the validation is now performed in the core-plugin
  • #17: the AzureDevOpsBuildServerData now uses BUILD_SOURCEBRANCH instead of BUILD_SOURCEBRANCHNAME

Getting the latest release

The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:

<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-plugin-core</artifactId>
    <version>6.0.0-rc.4</version>
</dependency>

Getting the latest snapshot (build automatically)

If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by github actions:

<pluginRepositories>
    <pluginRepository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </pluginRepository>
</pluginRepositories>

Even though the github actions will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.

Known Issues / Limitations:

  • N/A

Reporting Problems

If you find any problem with this plugin, feel free to report it here

Version 6.0.0-rc.3

16 May 18:36
Compare
Choose a tag to compare
Version 6.0.0-rc.3 Pre-release
Pre-release

Version 6.0.0-rc.3 is finally there and includes various bug-fixes and improvements.
Note that this library was previously part of the git-commit-id-maven-plugin so you might want relevant changes in the issues listed there too :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully. As of now this is only a release candidate. Future release candidates and the final 6.0.0 version may contain further breaking changes ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version:

  • Interface changes in GitCommitIdPlugin
    • For getPropertiesOutputFormat require now an Enum (CommitIdPropertiesOutputFormat) instead of a String
    • Replace getGenerateGitPropertiesFilename that was requiring a String with getGenerateGitPropertiesFilethat requires a File

New Features / Bug-Fixes:

The main key-aspects that have been improved or being worked on are the following:

  • None

Getting the latest release

The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:

<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-plugin-core</artifactId>
    <version>6.0.0-rc.3</version>
</dependency>

Getting the latest snapshot (build automatically)

If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by github actions:

<pluginRepositories>
    <pluginRepository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </pluginRepository>
</pluginRepositories>

Even though the github actions will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.

Known Issues / Limitations:

  • N/A

Reporting Problems

If you find any problem with this plugin, feel free to report it here

Version 6.0.0-rc.2

12 Apr 18:43
Compare
Choose a tag to compare
Version 6.0.0-rc.2 Pre-release
Pre-release

Version 6.0.0-rc.2 is finally there and includes various bug-fixes and improvements.
Note that this library was previously part of the git-commit-id-maven-plugin so you might want relevant changes in the issues listed there too :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully. As of now this is only a release candidate. Future release candidates and the final 6.0.0 version may contain further breaking changes ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version:

  • Reorganize Project-Structure
    • #6: replace pl.project13.core.log.LoggerBridge with pl.project13.core.log.LogInterface
    • a failure in the native command execution will now throw a GitCommitIdExecutionException
      instead of RuntimeException
    • #3: replace org.sonatype.plexus.build.incremental.BuildContext with pl.project13.core.util.BuildFileChangeListener that acts as call-back when the generatedProperties-File has been altered. Users of the core-plugin are thus expected to propagate those notifications further (e.g. to the plexus BuildContext)

New Features / Bug-Fixes:

The main key-aspects that have been improved or being worked on are the following:

  • #8: get file store attr async to improve jgit startup performance
  • #11 / #10: Add parameter in function maybeGeneratePropertiesFile in order to choose to escape unicode or not
  • various dependency updates

Getting the latest release

The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:

<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-plugin-core</artifactId>
    <version>6.0.0-rc.2</version>
</dependency>

Getting the latest snapshot (build automatically)

If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by github actions:

<pluginRepositories>
    <pluginRepository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </pluginRepository>
</pluginRepositories>

Even though the github actions will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.

Known Issues / Limitations:

  • N/A

Reporting Problems

If you find any problem with this plugin, feel free to report it here

Version 5.0.0

08 Jul 17:00
Compare
Choose a tag to compare

Version 5.0.0 is finally there and includes various bug-fixes and improvements.
Note that this library was previously part of the git-commit-id-maven-plugin so you might want relevant changes in the issues listed there too :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version:

New Features / Bug-Fixes:

The main key-aspects that have been improved or being worked on are the following:

  • #1: Added bamboo_buildNumber to the variables that will be checked when we are on a bamboo server (the addition avoids an empty build number)

Getting the latest release

The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:

<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-plugin-core</artifactId>
    <version>5.0.0</version>
</dependency>

Getting the latest snapshot (build automatically)

If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by github actions:

<pluginRepositories>
    <pluginRepository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </pluginRepository>
</pluginRepositories>

Even though the github actions will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.

Known Issues / Limitations:

  • N/A

Reporting Problems

If you find any problem with this plugin, feel free to report it here