gvlasov / git-version-insert-maven-plugin Goto Github PK

Put plugin description, usage insturctions and examples in README.md

Version 0.1 was developed with an incorrect assumption that to get the version of the file, we should track its parent commits until we find a tag. However, a tagged commit has to be created after all the changes going into that release. Therefore, by default the plugin should trace children instead of parents in the search for the closest tag. The old strategy can probably still be useful sometimes, so classes implementing it should not be removed just yet.

https://www.kernel.org/pub/software/scm/git/docs/git-tag.html

git-tag manual suggests that only annotated tags should be used to mark releases. Therefore, an option to ignore unannotated tags must be added, so they may be used freely, not intervening into versioning process.

Plugin should replace $stub$ with file revision number. It should be covered by tests.

$version-stub$ would be more explicit.

There is an issue with annotation processing that can be illustrated with this project, I should reproduce that issue in a PR in this project and report it to https://github.com/takari/takari-plugin-testing-project

When the first release is published on Maven Central, asnwer questions on stackoverflow that asked about how to programmatically fill out @version tags.