Release 3.0.1

[TheSnoozer]

This is the place holder to release the new 3.0.1 version.

Note that the current open tickets should be addressed, before performing a release.

General scope of the new release:

Fixed some minor things, added some minor features...(full list https://github.com/ktoso/maven-git-commit-id-plugin/issues?q=milestone%3A3.0.1).

Release-Guide

see http://central.sonatype.org/pages/ossrh-guide.html

• update dependencies mvn versions:display-dependency-updates

• wait for travis checks to pass

• mvn release:prepare
  [INFO] Checking dependencies and plugins for snapshots ...
  What is the release version for "Git Commit Id Maven Plugin"? (pl.project13.maven:git-commit-id-plugin) 3.0.1: [ENTER]
  What is SCM release tag or label for "Git Commit Id Maven Plugin"? (pl.project13.maven:git-commit-id-plugin) git-commit-id-plugin-3.0.1: v3.0.1 [ENTER]
  What is the new development version for "Git Commit Id Maven Plugin"? (pl.project13.maven:git-commit-id-plugin) 3.0.2-SNAPSHOT: [ENTER]

• wait for travis checks to pass

• mvn release:perform

• then go to oss.sonatype.org log in there and go to the staging repositories, there will be the plugin, you have to first close and then release it if validation passed.

• verify plugin is available on (might take some time) https://repo1.maven.org/maven2/pl/project13/maven/git-commit-id-plugin/

• close old milestone

• create new milestone for new version

• publish Release-Notes

• update readme to point to the latest version available

• run performance comparison with previous release (https://gist.github.com/TheSnoozer/7891eb9412c9584a052f00650d9c516b)

[ryantse]

@TheSnoozer: Is there an ETA on when you'd be releasing 3.0.1? It would be great to get the fixes and features that are now in master (offline option, fixed caching, and git.build.host exclusions).

[TheSnoozer]

Hi @ryantse that sounds reasonable and thank you for starting to scream (I usually only create a release when people ask for it)!

I guess the current change-set would be a nice 3.0.1 version, even though not all issues that are marked for 3.0.1 are included.

I started the process with #430 and will comment once the version is released (ETA: 1-2h).

[TheSnoozer]

Mhhh I just scanned through the open issues and I'm still not sure how to deal with the offline mode of the plugin. In general the offline mode introduces a more clearer way of avoiding the git fetch, however I wonder how many users really rely on the perfect properties.

Advantage of offline mode by default:

• no git fetch == no org.eclipse.jgit.api.errors.TransportException(s)
• Legacy user's from prior to 3.0.0 don't need to adjust their config (e.g. by specifying the offline mode)
• perhaps only a tiny fraction of users use the git.local.branch.ahead / git.local.branch.behind, but don't know about the filtering resulting in Exceptions

Disadvantage of offline mode by default:

• risk of having wrong git.local.branch.ahead / git.local.branch.behindproperties (maybe a nice warning would solve this?)
• New users who rely on the right and perfect git.local.branch.ahead / git.local.branch.behindproperties need to enable online mode (again maybe a nice warning would solve this?)

In sort I just would flip the default switch for the offline-mode from 'false' to 'true'.

I guess since this is the first release after 3.0.0 this would be a nice opportunity to make things straight.

Thoughts?

[ryantse]

Offline mode seems to be a functionality that somebody would opt-into rather than opt-out. Maven itself has a "mvn dependency:go-offline" and "-o" to enable offline mode, and I believe it would be fitting for the plugin to operate the same.

I'd lean towards leaving offline mode to be false by default.

[ryantse]

This is kind of late in the release cycle, but I realized that the injectAllReactorProjects runs every single time (instead of only the first time?). This may not be the intended functionality for users.

[TheSnoozer]

Thanks for your input!

Well yeah and to be fair that's kinda the annoying part of having so many config options. This plugin also has the <runOnlyOnce>true</runOnlyOnce> option that only runs the plugin on the root level. This usually gets combined with <skipPoms>false</skipPoms> since the root is in most cases a pom-build.

Any yeah I released the version already, so now it's too late :P

[TheSnoozer]

3.0.1 is available via https://repo1.maven.org/maven2/pl/project13/maven/git-commit-id-plugin/3.0.1/