A set of goals at Yupiik colors and easing automotion.
|
Important
|
documentation is available online at https://yupiik.io/tools-maven-plugin/. |
Plugin definition:
<plugin>
<groupId>io.yupiik.maven</groupId>
<artifactId>yupiik-tools-maven-plugin</artifactId>
<version>${yupiik-tools.version}</version>
</plugin>|
Tip
|
yupiik-tools-cli enables to run the slides and minisite tools without maven, run help on the fat jar (java -jar yupiik-tools-cli-<version>-fatjar.jar) to see the configuration.
|
|
Important
|
you can also consult out generated documentation, it will contain a more exhaustive content. |
Use a .git folder to generate an asciidoc report listing commits.
Simplest setup is to define the plugin and create a file src/main/pdf/index.adoc, then simply render it with:
mvn yupiik-tools:git-report| Name | Type | Default | Property | Description |
|---|---|---|---|---|
dotGit |
|
|
|
Where is |
target |
|
|
|
Where to render the asciidoc report. |
title |
|
|
|
The report title. |
overwrite |
|
|
|
If |
renderers |
|
|
|
How to generate the document (see after). |
filters |
|
|
|
How to filter git logs to generate the document content, depends on the renderers configured (see after). |
logFormat |
|
|
|
How to render a git log line (see after). |
- DEFAULT
-
alias for
REPOSITORY_METADATA, COMMITS_PER_NAME_PREFIX_CHRONOLOGICAL. - REPOSITORY_METADATA
-
creates a part with the repository URL and name, uses
originremote repository if possible. - COMMITS
-
simply logs all commits in reverse order (date) using the configured formatter (
logFormat). - COMMITS_CHRONOLOGICAL
-
simply logs all commits in order (date) using the configured formatter (
logFormat). - COMMITS_PER_EMAIL_PREFIX
-
same as
COMMITSbut groups each log lines in a part dedicated to theemailassociated to the commit. - COMMITS_PER_EMAIL_PREFIX_CHRONOLOGICAL
-
same as
COMMITS_PER_EMAIL_PREFIXbut sorted by date. - COMMITS_PER_NAME_PREFIX
-
same as
COMMITSbut groups each log lines in a part dedicated to thenameassociated to the commit. - COMMITS_PER_NAME_PREFIX_CHRONOLOGICAL
-
same as
COMMITS_PER_NAME_PREFIXbut sorted by date.
- from
-
date in
yyyy-MM-ddformat to include commits from (inclusive). - to
-
date in
yyyy-MM-ddformat to include commits to (inclusive). - mailRegex
-
java regex to filter commits per email, it can be used to include only the commits from members of a company for example.
- STAR
-
renders
*. - BACKQUOTE
-
renders
`. - COLON
-
renders
:. - SPACE
-
renders a space.
- OPEN_BRACKET
-
renders
[. - CLOSE_BRACKET
-
renders
]. - OPEN_PARENTHESIS
-
renders
(. - CLOSE_PARENTHESIS
-
renders
). - SHA
-
renders commit short sha (abbreviated to 7 chars).
- DATE
-
renders commit date.
- AUTHOR
-
renders committer name.
-
renders committer email.
- MESSAGE
-
renders commit short message.
- FULL_MESSAGE
-
renders commit full message.
|
Tip
|
this goal can be chained with PDF one to render the log in one command (adjust the version, the sample uses the minimal one): |
mvn \
io.yupiik.maven:yupiik-tools-maven-plugin:1.0.23:git-report \
io.yupiik.maven:yupiik-tools-maven-plugin:1.0.23-SNAPSHOT:pdf \
-Dyupiik.workDir=work \
-Dyupiik.git-report.dotGit=/path/to/project/.git \
-Dyupiik.git-report.target=log.adoc
-Dyupiik.pdf.source=log.adoc \
-Dyupiik.pdf.target=.Render an asciidoctor file in PDF.
Simplest setup is to define the plugin and create a file src/main/pdf/index.adoc, then simply render it with:
mvn yupiik-tools:pdf|
Tip
|
watch-pdf goal exists and just keeps re-rendering your adoc to pdf when something changed in the source directories. You can exit it with Ctrl+C command.
|
|
Tip
|
some default roles are defined in the theme and can be used to color the icons ([xxx]).
Here are the default ones:
|
red:
font-color: #ff00ff
green:
font-color: #00ff00
blue:
font-color: #0000ff
red-darker:
font-color: #cc0000
green-darker:
font-color: #006600
yupiik:
font-color: #0075bb
yupiik_dark:
font-color: #054470| Name | Type | Default | Property | Description |
|---|---|---|---|---|
attributes |
|
|
|
Custom attributes. |
customCss |
|
|
|
Custom css if needed, overrides default one for revealjs (as intended by the backend) and append it to yupiik one for bespoke. |
mode |
|
|
|
Which execution mode to use, WATCH and SERVE are for dev purposes. |
port |
|
|
|
For SERVE mode, which port to bind. |
source |
|
|
|
Slide deck source file. |
targetDirectory |
|
|
|
Where to render the slide deck. |
workDir |
|
|
|
Where to extract files needed for the rendering. |
Stem/Math formulas Asciidoctor integration is done through mathematical gem which uses native bindings not supported by JRuby.
Therefore you can’t use it with PDF.
To workaround this issue, PDF plugin provides jlatexmath (open block macro, i.e. delimited with --) and jmath (inline macro) allowing you to use inline LaTeX formulas.
To activate it you must add jlatexmath dependency:
<plugin>
<groupId>io.yupiik.maven</groupId>
<artifactId>yupiik-tools-maven-plugin</artifactId>
<configuration>
<!-- ... -->
</configuration>
<dependencies>
<dependency>
<groupId>org.scilab.forge</groupId>
<artifactId>jlatexmath</artifactId>
<version>1.0.7</version>
</dependency>
</dependencies>
</plugin>Example:
[jlatexmath]
--
x = a + b
--
This formula (jmath:_[a + b]) is cool.Render an asciidoctor reveal.js slide deck in HTML.
Simplest setup is to define the plugin and create a file src/main/slides/index.adoc, then simply render it with:
mvn yupiik-tools:slidesYou can also pass in HTTP mode with:
mvn yupiik-tools:serve-slides|
Tip
|
to convert slides to PDF, you can use decktape. Launch the slides HTTP server and then run docker run --rm -t --net=host -v $PWD:/slides astefanutti/decktape http://localhost:4200 slides.pdf.
|
| Name | Type | Default | Property | Description |
|---|---|---|---|---|
attributes |
|
|
|
Custom attributes. By default _partials and images folders are set to partialsdir and imagesdir attributes. |
sourceDirectory |
|
|
|
Source directory or file to render, if a directory all files with extension .adoc will be selected. |
targetDirectory |
|
|
|
Where to render the asciidoc files to. |
themeDir |
|
|
|
Theme directory (name of the theme is yupiik), let it null to inherit from the default theme. |
workDir |
|
|
|
Where to extract files needed for the rendering. |
slider |
|
|
|
Which renderer to use for slides, reveal.js or bespoke.js. |
synchronizationFolders |
|
|
|
List of synchronization folder for the output, source will be taken (file) and copied relatively to target directory, appending target value before the relative path of the file. |
Audit mojo uses the fact the plugins are "Maven aware" to generate an audit report inheriting from PDF mojo. It uses the same configuration but works on a reactor.
|
Tip
|
it is recommended to set source relative to multiple module dir and not project basedir since this one can be random.
|
Here is a sample execution from the CLI:
$ mvn io.yupiik.maven:yupiik-tools-maven-plugin:${plugin.version}:audit \
-Dyupiik.pdf.source=$PWD/report.adoc \
-Dyupiik.pdf.target=/tmp/report
[...]
mvn io.yupiik.maven:yupiik-tools-maven-plugin:1.0.0-SNAPSHOT:audit -Dyupiik.pdf.source=report.adoc -Dyupiik.pdf.target=/tmp/report.pdf
[INFO] --- yupiik-tools-maven-plugin:1.0.0-SNAPSHOT:audit (default-cli) @ my-module ---
[INFO] Generating audit report
[INFO] Rendered 'report.adoc'A more complete example to skip a module, skip some plugins and ensure dependencies are available can be:
mvn \
compile -Dcompiler.skip=true \ (1)
io.yupiik.maven:yupiik-tools-maven-plugin:${plugin.version}:audit \ (2)
-Dyupiik.pdf.source=$PWD/report.adoc -Dyupiik.pdf.target=/tmp/report \
-Dlicense.skip=true -Dfront.build.skip=true \ (3)
-pl -documentation (4)-
go through compile phase (skipping it) to ensure compile dependencies are resolved,
-
our audit plugin after the resolution plugins,
-
skip license and front plugins (depends your plugins),
-
skip documentation module.
Report will be in /tmp/report/report.pdf.
|
Note
|
report does not have to be in the project ;). |
Here is a sample report:
= Report == Dependencies [maven_dependencies,scope=compile_only,aggregated=true] (1) -- --
-
the
aggregated=trueenables to generate a single report for all the reactor at once.
Minisite enables to render a static website with a generic Yupiik template or a custom one with some configuration. It comes with its companion serve goal to have a live preview.
|
Tip
|
as all plugins it requires Java 11 but if you want to use it with Java 8 you can use minisite-core module with exec-maven-plugin since version 1.1.1.
|
mvn yupiik-tools:minisite
mvn yupiik-tools:serve-minisite| Name | Type | Default | Property | Description |
|---|---|---|---|---|
attributes |
|
|
|
Custom attributes. |
source |
|
|
|
Source directory or file to render. |
target |
|
|
|
Where to render the minisite. |
title |
|
|
|
Default title if page has no title. |
description |
|
|
|
Default description if page has no title. |
siteBase |
|
|
Base of the site. |
|
searchIndexName |
|
|
|
Should search.json be generated and if not |
generateIndex |
|
|
|
Should index be generated from the pages. |
generateSiteMap |
|
|
|
Should sitemap be generated. |
templatePrefixes |
|
|
|
List of html templates to prepend to the content. |
templateAddLeftMenu |
|
|
|
Should a left menu inheriting from index logic be generated. |
templateSuffixes |
|
|
|
List of html templates to append to the content. |
useDefaultAssets |
|
|
|
Should default css/js be extracted and added to the website. |
customHead |
|
|
|
String injected at the end of head tag of html pages. |
customScripts |
|
|
|
String injected at the end of script tags of html pages. |
customMenu |
|
|
|
String injected on the top left of the menu (just before the search). |
logoText |
|
|
|
Logo text for default theme (text next to the logo). |
indexText |
|
|
|
Index homepage (when generated) content title. |
indexSubTitle |
|
|
|
Index home page (when generated) subtitle. |
copyright |
|
|
|
Footer copyright for the default theme. |
linkedInCompany |
|
|
|
Name of the company as on linkedin link. |
logo |
|
|
|
Logo url. |
preActions |
|
|
|
List of pre actions to execute before the rendering ( |
reverseBlogOrder |
|
|
|
Sort by reversed published date the posts on index pages. |
injectBlogMeta |
|
|
|
Add to the top of blog posts the author names (with link to their page), published date and reading time. |
blogPublicationDate |
|
|
|
Max publication date supported for posts, enables to preview future posts in "writing" mode. |
blogPageSize |
|
|
|
How many post to put on a single index/list page. |
addIndexRegistrationPerCategory |
|
|
|
Should categories be added to home page. |
skipIndexTitleDocumentationText |
|
|
|
Should ` Documentation` be appended to index text. |
logoSideText |
|
|
|
Text next logo text, generally the subproject or just |
injectYupiikTemplateExtensionPoints |
|
|
|
Should Yupiik custom points be used (alias for multiple custom extension points, only override missing ones). |
templateExtensionPoints |
|
|
|
Values for custom template extension points like |
gravatar |
|
|
|
An object where gravatar URL pattern can be configured. Default is equivalent to: |
|
Tip
|
most of texts can be deduced from logText and indexSubTitle so ensure to set these two to contextualize your minisite.
|
The configuration also supports a ftp entry if you want to upload to a FTP server the generated website:
| Name | Type | Description | username | String |
|---|---|---|---|---|
Username if serverId is not set. |
|
|
|
serverId |
String |
|
|
|
FTP url ( |
The configuration also supports a git entry if you want to upload to a Git branch the generated website (like gh-pages):
| Name | Type | Description |
|---|---|---|
branch |
|
Git branch to update (default to |
username |
|
Username if serverId is not set. |
password |
|
Password if serverId is not set. |
serverId |
|
ServerID to use to get username/password from settings.xml - default to |
url |
|
Git url. |
ignore |
|
Should the execution be skipped - enables to set a maven variable. |
prefix |
|
Prefix prepended to file in the git repo (ex: |
noJekyll |
|
Will force a |
envBase64SshKey |
|
Environment variable the private key will be read as base64 encoded from - useful on CI. note that |
The configuration also supports an experimental Atlassian Confluence export support.
It only works using the default template and require a configuration similar to git or ftp exports:
<profile> <!-- mvn clean package -Pconfluence -->
<id>confluence</id>
<build>
<plugins>
<plugin>
<groupId>io.yupiik.maven</groupId>
<artifactId>yupiik-tools-maven-plugin</artifactId>
<executions>
<execution>
<id>confluence</id>
<phase>prepare-package</phase>
<goals>
<goal>minisite</goal>
</goals>
<configuration>
<confluence>
<ignore>false</ignore>
<url>https://base.atlassian.net/wiki/</url> <!-- for cloud, for an on premise instance the /wiki/ is not always needed -->
<authorization>Basic base64_value_of(your mail:your token)></authorization>
<space>YOURSPACE</space>
<skipIndex>false</skipIndex> <!-- if true, will skip all index.html files -->
</confluence>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>|
Important
|
the nested support of this exporter is very experimental, and we recommend you to keep only one level of .adoc files using it.
|
-
Assets are not uploaded so ensure to configure Asciidoctor to embed all assets in HTML,
-
It only works with the default theme since we extract metadata from there to enable to update the space,
-
To look nice, you can need to tune the Confluence space CSS to import admonitions, codeblocks, …​ styling (can require some admin permissions).
Blog is supported if pages contain at least one block metadata. Here is the list of available attributes you can use:
-
:minisite-blog-published-date: yyyy-MM-dd: when the page will be rendered (if not set it is always rendered). -
:minisite-blog-categories: c1,c2: comma separated list of categories of this post -
:minisite-blog-authors: My, Myself: comma separated list of author names -
:minisite-blog-summary: Some short description.: the summary of this post used on post list pages.
Blog page example:
= My Post
:minisite-blog-published-date: 2021-02-16T16:00
:minisite-blog-categories: others,simple
:minisite-blog-authors: Romain Manni-Bucau
:minisite-blog-summary: Second post.
Bla blaPre actions enables to generate some content from the project.
It is typically used to generate configuration from code or things like that.
It uses the documentation module classpath.
Actions must implement Runnable and can have some (public) constructor parameters (we use parameter names to match so ensure to enable -parameters in maven compiler plugin):
-
configuration(Map<String, String>): the action configuration, it enables to reuse it if needed or write generic actions -
sourceBase(Path): the base directory you can generate.adocinto (generally where you sources are, tip: usegeneratedfolder to be able to exclude it in.gitignoreif desired) -
outputBase(Path): the base directory you can generate direct html assets
Using type=maven-plugin (recommended) or type=io.yupiik.maven.service.action.builtin.MojoDocumentationGeneration you can get a plugin.xml file parsed to generate:
-
One file per goal with some usage, the goal description and parameters (named
<goal>.adoc) -
One file listing all goals (named
<goal-prefix>-maven-plugin.adoc)
The configuration of this action is:
-
pluginXml: file path or resource to find theplugin.xmlfile. -
toBase: where to generate theadoc. -
description: a global plugin description for the "listing" page (default is empty and page will just list goals).
Using type=copy (recommended) or type=io.yupiik.maven.service.action.builtin.CopyFile will copy a file from a source to a destination:
It is typically useful for assets (openapi.json for example).
-
from: source file. -
to: destination.
Using type=jsonschema (recommended) or type=io.yupiik.maven.service.action.builtin.JsonSchemaGenerator will generate a JSON-Schema from a class:
-
class: the class to generate the schema from. -
to: destination of the schema. -
type:JSONfor a raw JSON-Schema (default) orADOCfor a textual, asciidoctor output. -
setClassAsTitle:trueto force object title to be the class name. -
useReflectionForDefaults:trueto force reflection to try to extract defaults of attributes. -
prettywhen type=JSON, should the JSON be prettified or not (default=true). -
levelPrefixwhen type=ADOC, a title prefix (==for example),=by default. -
titleanddescriptionenable to set class title/description for its json schema. It is required for type=ADOC. -
annotationOnlyProvidesTheDescriptionenable to never take the title from an annotation (@Description(value)case).
|
Note
|
the model classes can use a custom @Description(title,description) annotation (note that @Doc is also supported and value method can be used instead of description).
See JsonDocExtractor for more details.
|
Using type=openmetrics2adoc (recommended) or type=io.yupiik.tools.minisite.action.builtin.OpenMetricsToAsciidoc will generate an asciidoctor form from an OpenMetrics export.
-
source: path of the openmetrics dump. -
to: destination of the asciidoc generated fromsource. -
levelPrefix: a prefix set before the part title (`== ` by default for a second level title). -
legend: should tables have a legend (name of the metric), default totrue. -
header: prefix the whole rendering (enables to set a title and some options if needed).
Using type=simple-configuration (recommended) or type=io.yupiik.tools.minisite.action.builtin.SimpleConfigurationGenerator will generate an asciidoctor from a configuration class passed in class <configuration> option.
-
class: root configuration fully qualified name. -
output: where to generate the.adocto.
Using type=replace-in-file (recommended) or type=io.yupiik.tools.minisite.action.builtin.ReplaceInFile will rewrite a text file replacing a string by another one.
-
source: file to rewrite. -
token: text to replace. -
replacement: text replacingtoken.
|
Tip
|
using regex{xxx} as token will use a java regex to do the replacement.
|
<plugin>
<groupId>io.yupiik.maven</groupId>
<artifactId>yupiik-tools-maven-plugin</artifactId>
<executions>
<execution>
<id>build-and-deploy-doc</id>
<phase>package</phase>
<goals>
<goal>minisite</goal>
</goals>
<configuration>
<siteBase>https://yupiik.github.io/${project.artifactId}</siteBase>
<logoText>My Product</logoText>
<indexSubTitle>The top product.</indexSubTitle>
<ftp>
<serverId>http://mini.yupiik.net</serverId> <!-- default is siteBase -->
<url>ftp://ftpupload.net/htdocs</url>
</ftp>
</configuration>
</execution>
</executions>
</plugin>Some specific attributes enables to customize the generation. Here is their list:
-
minisite-skip=[true|false]enables to skip a.adocrendering even if not in_partialsdirectory. -
minisite-path=<string>enables to force the relative path of the file, for example a file name foo-bar.adoc with the attributeminisite-pathset tofoo/bar.htmlwill output afoo/bar.htmlfile instead offoo-bar.html. Note however it does not rewrite the links to ensure to use…​..htmlinstead ofrefto link this page then. -
minisite-highlightjs-skipenables to not setup highlight.js for the page (useful with swagger-ui for example).
To include a page in the index it must contain minisite-index attribute.
Its value is the order of the entry in the index tiles.
|
Tip
|
ensure to not use 1, 2, 3, …​ but rather 100, 200, …​ to easily insert an item later.
|
-
minisite-index-titleattribute enables to override link text. -
minisite-index-iconattribute enables to override font awesome icon (withoutfa-prefix). -
minisite-index-descriptionattribute enables to override the text in the index tile for the page entry.
Fetch versions of the defined artifacts on a nexus and ensures it is set as github release artifacts.
Name: synchronize-github-releases.
|
Tip
|
if you use maven central you need to await for the synchronization to run this goal, using directly OSS sonatype release repository avoids it. |
| Name | Type | Description |
|---|---|---|
githubServerId |
|
Github serverId to use (from your settings.xml) to get the token to use to call github API. |
nexusServerId |
|
Nexus serverId to use (from your settings.xml) to get the token to use to call nexus, not needed if mavenRepositoryBaseUrl is central (default). |
mavenRepositoryBaseUrl |
|
Maven repository base url - where |
githubRepository |
|
Which github repository to synchronize ( |
githubBaseApi |
|
Base API url for github REST API (default on public one). |
artifacts |
|
List of artifacts to synchronize ( |
attachIfExists |
|
If release already exists the default behavior is to skip it, this flag enables to still try to attach artifacts to this release anyway. |
tagPattern |
|
Tag name to link to the release, default uses |
<plugin>
<groupId>io.yupiik.maven</groupId>
<artifactId>yupiik-tools-maven-plugin</artifactId>
<executions>
<execution>
<id>default-cli</id>
<phase>none</phase>
<goals>
<goal>synchronize-github-releases</goal>
</goals>
<configuration>
<!-- defaults so optional -->
<githubServerId>github.com</githubServerId>
<nexusServerId />
<mavenRepositoryBaseUrl>https://repo.maven.apache.org/maven2/</mavenRepositoryBaseUrl>
<!-- required configuration -->
<githubRepository>yupiik/tools-maven-plugin</githubRepository>
<artifacts>
<artifact>
<groupId>io.yupiik.maven</groupId>
<artifactId>yupiik-tools-maven-plugin</artifactId>
<artifacts>
<artifact>
<type>jar</type>
<classifier />
</artifact>
<artifact>
<type>pom</type>
<classifier />
</artifact>
<artifact>
<type>jar</type>
<classifier>sources</classifier>
</artifact>
<artifact>
<type>jar</type>
<classifier>javadoc</classifier>
</artifact>
</artifacts>
</artifact>
</artifacts>
</configuration>
</execution>
</executions>
</plugin>Then run mvn yupiik-tools:synchronize-github-releases.
Convert cucumber JSON report(s) into an asciidoc file which can be rendered with PDF or HTML goals.
Name: cucumber2asciidoc.
| Name | Type | Property |
|---|---|---|
Description |
|
File |
yupiik.cucumber.source |
|
target |
File |
|
Output asciidoc file path. Default: |
prefix |
|
yupiik.cucumber.prefix |
Header (top, i.e. before report) of the document. |
|
String |
<plugin>
<groupId>io.yupiik.maven</groupId>
<artifactId>yupiik-tools-maven-plugin</artifactId>
<executions>
<execution>
<id>default-cli</id>
<phase>none</phase>
<goals>
<goal>cucumber2asciidoc</goal>
</goals>
<configuration>
<prefix>= My Cucumber Report</prefix>
<suffix></suffix>
<source>${project.build.directory}/cucumber-reports/</source>
<target>${project.build.directory}/generated-adoc/cucumber.report.adoc</target>
</configuration>
</execution>
</executions>
</plugin>Then run mvn yupiik-tools:cucumber2asciidoc.
|
Tip
|
indeed it can be chained with yupiik-tools:pdf.
|
This MOJO enables to initialize a folder with a Bash CLI structure.
Usage:
mvn yupiik-tools:script-cli-skeleton -Dyupiik.script-cli-skeleton.directory=/path/to/skeleton| Name | Type | Property |
|---|---|---|
Description |
|
File |
yupiik.script-cli-skeleton.directory |
|
generateHelloWorldCommand |
boolean |
|
Should a default command be added or not. |
|
Tip
|
can be used on a pomless project: mvn io.yupiik.maven:yupiik-tools-maven-plugin:<version>:script-cli-skeleton -Dyupiik.script-cli-skeleton.directory=/path/to/script-project (version >= 1.0.26).
|
The project adds asciidoc macros to get back some maven build information. Note that it must be executed in the right lifecycle phase if using some project metadata (plugin does not require any resolution to be usable standalone).
Enables to list the project dependencies.
This extension sets up the equivalent of a parent pom but enables to inherit or not from another parent and to benefit from upgrades for free.
It is configured in the root project through maven properties:
<properties>
<!-- REQUIRED: enable the extension -->
<yupiik.oss.enabled>true</yupiik.oss.enabled>
<!-- OPTIONAL: defaults -->
<yupiik.oss.java.version>11</yupiik.oss.enabled>
<yupiik.oss.encoding>UTF-8</yupiik.oss.enabled>
<yupiik.oss.javadoc.doclint>none</yupiik.oss.enabled>
<yupiik.oss..sign.skip>none</yupiik.oss.enabled>
</properties>Just enabling this extension will upgrade a few plugin, enforce the encoding and java version, enforce license check and much more.
See io.yupiik.maven.extension.YupiikOSSExtension.afterProjectsRead for details.
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<!-- ... -->
<properties>
<yupiik.oss.enabled>true</yupiik.oss.enabled>
</properties>
<build>
<extensions>
<extension>
<groupId>io.yupiik.maven</groupId>
<artifactId>yupiik-tools-maven-plugin</artifactId>
<version>${yupiik-tools.version}</version>
</extension>
</extensions>
</build>
<profiles>
<profile>
<id>release</id>
</profile>
</profiles>
</project>It enables to put in each module a YupiikContributor.java file which will be compiled and executed in afterProjectRead(MavenSession) callback.
Example:
import org.apache.maven.AbstractMavenLifecycleParticipant;
import org.apache.maven.execution.MavenSession;
import org.codehaus.plexus.component.annotations.Component;
@Component(role = AbstractMavenLifecycleParticipant.class, hint = "my-module-customizer")
public class YupiikContributor extends AbstractMavenLifecycleParticipant {
@Override
public void afterProjectsRead(final MavenSession session) {
System.out.println(">>>> hello: " + session);
}
}This enables to programmatically handle the pom (mainly intended for plugins since dependencies are not synchronized in maven poms when contributed this way).
To enable it, enable the related extension:
<build>
<extensions>
<extension>
<groupId>io.yupiik.maven</groupId>
<artifactId>yupiik-tools-maven-plugin</artifactId>
<version>${yupiik-tools-maven-plugin.version}</version>
</extension>
</extensions>
</build>|
Tip
|
see io.yupiik.maven.extension.YupiikOSSExtension for a more complex participant example.
|