JarCastingpom-yaml maven extension
pom.yml
pom-yaml-maven-extension introduces pom.yml configuration that accompanies pom.xml. The configuration is yet another way to replace what you can achieve using maven command line parameters.
- Maven goals (before and after)
- Maven profile
- User properties
- System properties
Goals
pom.yml allows to configure so called before goals and after goals. before goals are injected by the plugin before the command line goals. Respectively, after goals are injected after the command line goals. If user does not provide any goals in command line the extension injects goals from on-empty list. It's helpful to produce an output info about the project.
Example:
session:
goals:
before:
- clean
after:
- sonar:sonar
on-empty:
- help:effective-settings
So the following maven command line withe the pom.xml above
mvn install
will be the same as you would try to execute the following:
mvn clean install sonar:sonar
Project GIT url
If there is a user property pom-yaml.scm.git.load-git-url set to true the extension parses git configuration file .git/config and extracts a URL from [remote "origin"] section and set the URL value to pom-yaml.scm.git.git-url user project.
mvn clean install -Dpom-yaml.scm.git.load-git-url=true
if project has .git/config file accessible and remote repository is set then you can use a remote URL value in pom-yaml.scm.git.git-url in the pom.xml. It sets the following properties:
| Name | Description |
|---|---|
pom-yaml.scm.git.git-url |
project scm url |
pom-yaml.scm.git.git-url.path |
project scm url path |
pom-yaml.scm.git.git-url.ext |
project scm url extension (.git) |
pom-yaml.scm.git.git-url.host |
project scm url host |
pom-yaml.scm.git.git-url.schema |
project scm url schema |
pom-yaml.scm.git.git-url.port |
project scm url port |
pom-yaml.scm.git.git-url.user |
project scm url user |
Installation
Follow maven guidance to setup maven extension as described in Maven Extension Demo Study. To configure the extension, use ${maven.projectBasedir}/.mvn/extensions.xml method.
Example of .mvn/extensions.xml configuration file:
<extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd">
<extension>
<groupId>org.metalib.maven.extension</groupId>
<artifactId>pom-yml-maven-extension</artifactId>
<version>0.0.10</version>
</extension>
</extensions>
Example
This pom.yml activates maven-surefire-plugin-skip and sonar-skip maven profiles and deactivates docker-skip. It sets up maven.test.skip maven property to true.
---
session:
goals:
before:
- clean
after:
- install
on-empty:
- help:effective-settings
profiles:
active:
- maven-surefire-plugin-skip
- sonar-skip
inactive:
- docker-skip
user-properties:
maven.test.skip: true
system-properties:
checksum: 0000
The example above is equivalent to the following command line maven call:
mvn -Pmaven-surefire-plugin-skip,sonar-skip,!docker-skip -Dmaven.test.skip=true
