scm-metadata-maven-plugin

Maven plugin to inject metadata about the SCM in use for the project into your build as Maven properties, for re-use by other plugins.

Similar in spirit to the Buildnumber Maven Plugin, with the following key differences:

1. Focus specifically on SCM metadata
2. Richer set of metadata included
3. Greater control over injected properties

See the documentation for details.

SCM support

Currently supported SCM implementations:

• git

PRs adding support for additional SCM providers are welcome, the eventual goal is to support all of the most commonly used SCMs supported by Maven itself

Developer Information

Project Requirements

Building the plugin requires a Java 9+ JDK (although the project is compiled against the Java 7 SDK).

Building

To build the project:

mvn clean install

To build the plugin documentation:

mvn clean site

For compatibility with github-pages, the documentation is deployed into the docs folder. To build the documentation and deploy it into this folder, run

mvn clean site-deploy

IDE integration

This project utilizes Project Lombok, so ensure you add the appropriate plugins to your IDE.

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.