Reference
The earlier chapters built up Jenesis one topic at a time. This one is the flat reference you come back to:
how to invoke the build, the target and selector grammar, every jenesis. configuration key with its
default, and the vocabulary of built-in steps a selector can name. Each entry links to the chapter that
explains it in full.
Invoking the build
Every project ships its build as source under build/. The canonical invocation
recompiles that engine and runs it:
java build/jenesis/Make.java [selectors…]
A package-manager install (see Getting started) adds a second form:
| Form | Invocation | Notes |
|---|---|---|
| Source | java build/ |
The canonical form; compiles the embedded engine on each run. |
| Installed | jenesis |
The command from SDKMAN, Homebrew or Scoop. It runs the installed engine against the current directory, not the sources under build/, so it also builds a project that embeds none. |
Settings may lead the arguments after the main class (java build/), and @<file> stands for the arguments a file holds - # comments
to the end of a line, quotes group, @@<text> is a literal @, and a file names no further file. See
Configuration.
-Djenesis.process.factory=tool|fork:
tool (the default) runs javac/jar in-process; fork runs
them as separate processes for stricter sandboxes. A GraalVM native image defaults to fork
unless it holds javac, as the engine's image under jenesis.make.mode=native does.
Targets
Positional arguments are selectors. With none, the build runs its default target, build, which
compiles and packages every module. Project. changes the default (there is no matching
property). The top-level targets the shipped layouts register:
| Target | What it runs |
|---|---|
build |
Compile, check, test, and package every module (the default). |
stage |
Materialise the release tree under target/ (see Publishing). |
export |
Publish the staged tree - into the local Maven repository (~/), the local module repository (~/), or both, depending on the layout. |
release |
Put the staged trees into the repositories jenesis. and jenesis. name, and run the plugins of the hook point release - a dry run that names what it would put unless the command line passes -Djenesis. (see Publishing). |
plugin/ |
Run a plugin the project names under the hook point plugin, which runs only when named (see Extending the build). |
pin |
Rewrite every pom. / module-info. so the transitive closure is pinned at source, after building, staging and a dry release (see Pinning & bills of materials). |
dependencies |
Print each module's resolved dependency graph with licences; named alone, it runs no tests unless -Djenesis. asks. |
ide |
Generate IntelliJ IDEA, VS Code, and Eclipse project metadata at the project root (see Building & running). |
help |
Print a one-screen orientation: how to start, the selectors, and how to make a step verbose. |
skill |
Print the briefing a coding agent works from, every page of it; skill/ prints the overview, which names the pages, and skill/ one page. |
prompt |
Print a task to hand a coding agent; prompt/ is the move of a Maven or Gradle build (see Migrating a Maven or Gradle build). |
metadata |
Refresh the metadata module outputs without building artifacts. |
configuration |
Print every setting with the value in force, one per line: jenesis.. Built to grep, and the tool's own property reference. |
properties |
Print every jenesis. setting in force for this run - from the command line, jenesis. or a profile alike - sorted by key. |
Selectors
A selector picks part of the build graph. Three shapes exist.
Module selectors start with +: the active layout rewrites +<name> into that module's path, so one
module builds without dragging in its siblings. A nested module is named by joining its path segments with
+, as in +api+client. + alone names the module whose descriptor sits at the project root - a root
pom. that is itself a module; an aggregator-only root or a pure modular project has no such module.
java build/jenesis/Make.java +mymodule # build just this module's subgraph
Path selectors are a slash-delimited path of module/ identities matched against the graph, with two
wildcards:
:matches exactly one segment.::matches any depth -::/matches everysign signstep anywhere in the tree.
Wildcards are lenient: a branch that fails to match is silently skipped. A literal path that does not
resolve throws Unknown selector: …. Once a step is matched, its predecessors run unconditionally, so its
inputs are always real folders.
| Invocation | What runs |
|---|---|
java build/ |
The default target, build: the whole graph. On a warm cache, every step is [SKIPPED]. |
java build/ |
Every test step at any depth, plus its predecessors. |
java build/ |
The same, anchored under the top-level build module. |
java build/ |
Only the named module's subgraph; in a pom. project, its tests as well. |
java build/ |
Only the api/ module's pins. |
A +<module> selector narrows build and nothing else. pin, stage and export are entry points of
their own, so pin +mymodule runs the whole project's pin and that module's build rather than a pin
narrowed to one module. To pin a single module, name its step: the pin target holds one
module-<path> step per module, where <path> is the module's source folder URL-encoded, because a
selector splits on /.
Configuration keys
Every knob is a system property, passed with -D or set in a jenesis. file - see
Configuration for files, profiles, and precedence. Some also read an environment
variable as a fallback. Defaults apply when the key is unset.
The build prints this same catalogue for itself: configuration lists every key with the value in force and
where it came from, one line each, so configuration | grep cache answers what is available and what is set
in one step.
Project & layout
| Key | Default | Effect |
|---|---|---|
jenesis. |
auto |
The layout: auto, maven, modular, modular_. |
jenesis. |
target |
The per-build output folder. Safe to delete for a clean build. A project's own file names only a folder inside the project. |
jenesis. |
(none) | Phases of the modules a module depends on that its build waits for, comma-separated - verify makes a module build only once the modules it depends on passed their checks. By default a module's build waits for their builds alone - see A module builds in phases. |
jenesis. |
(off) | A folder, absent or empty, to build the selection into a second time without any build cache, then compare what every step wrote in both builds and print a fingerprint of the whole build: a clean comparison deletes the folder, and a difference keeps it, without failing the build, naming the steps that wrote a different output from the same input before the steps handed that output - see Checking that a build reproduces. Read by Make. and jenesis-make, not by Execute.. A project's own file names only a folder inside the project. |
jenesis. |
(unset) | Stamps this version onto every artifact the build produces. It must be a module version, starting with a digit, as 1.; any other value is refused, an empty one included. In a pom. project it replaces the version of every module, and a dependency on a sibling module takes it as well. Unset, a module stays unversioned - no version in its descriptor and none in its path in the modular tree - and its generated POM, which cannot omit one, carries 0-SNAPSHOT. |
jenesis. |
(unset) | The source control tag recorded in the generated POM's <scm> and in the SBOM; empty records none, even over a declared scm. (see Publishing). |
jenesis. |
(unset) | The source revision, for Git the commit id, recorded in the SBOM; empty records none, even over a declared scm.. |
jenesis. |
(unset) | The Git tree id of the release, as git rev-parse HEAD^{tree} prints it, recorded in the SBOM as a SWHID; empty records none, even over a declared scm.. |
jenesis. |
(unset) | Comma-separated project-level metadata files for the POM and the SBOM. Unset reads project. at the project root when it exists; an empty value reads none. |
jenesis. |
false |
Also assemble a per-module sources jar, for every staged module. |
jenesis. |
false |
Also assemble a per-module javadoc jar, for every staged module. |
jenesis. |
false |
Archive that javadoc jar with nothing but an INTENTIONALLY_ file in it instead of rendering the documentation, for a repository such as Maven Central that requires the jar but not its content (see Publishing). |
jenesis. |
false |
Document every staged module but the test modules in one javadoc run, from their sources jars, and stage the site as target/ and javadoc.; requires jenesis. and attaches the jar to no Maven coordinate (see Building & running). |
jenesis. |
true |
Convert the project's AsciiDoc documents with Asciidoctor where an asciidoctor. in the configuration folder names their folder as documents=, and stage them with the project's files; false leaves it out. |
jenesis. |
(unset) | Comma-separated <path>:<target> pairs of project files or folders placed among the resources of every module, as LICENSE:META-INF/ (see Supply-chain features). |
jenesis. |
false |
Keep the process alive and rebuild on every source change (see Building & running). |
The entry point (build/jenesis/Make.java )
Make is the entry point every command names. It carries no build logic and names no engine class, so the
Java launcher compiles one small file rather than the whole engine before the build starts. These settings are read from the command
line, from your own ~/ and from jenesis. at the project root, in that
order of precedence.
| Property | Default | Effect |
|---|---|---|
jenesis. |
. |
The directory scanned for module-info. / pom.. Command-line only. |
jenesis. |
(unset) | Comma-separated profile names to activate. |
jenesis. |
daemon |
How the engine runs. source runs it from the build sources, which the launcher compiles class by class as it loads them. compiled compiles them once and runs the build from those classes, over a class loader of their own; one batch compile beats the launcher, so this is faster even for a build that runs a single time. aot starts those classes from an ahead-of-time cache, trained by the first build and read by every later one. native runs a native image of the engine, compiled by the native-image of the GraalVM running Make from what its tracing agent recorded; a build the image cannot run fails. daemon hands the build to a reused JVM, which keeps a warm JIT between calls; --stop as the sole selector shuts down every daemon. Unset, a build runs in the daemon, or compiled where jenesis. names fork or aot, jenesis. is set, or jenesis. publishes. The first progress line and the started event name the mode a build ran in. |
jenesis. |
. |
Where those classes land, relative to the folder the command runs in on the command line and to the project root in a file. They go under . with the rest of the build's by-products, so nothing lands in the sources. A project's own file names only a folder inside the project. |
jenesis. |
(unset) | The JDK the build runs on, as 25, 25. or 25-temurin. Make. and Execute. start again on a matching installed JDK when the running one does not match (see Building & running). |
jenesis. |
@ |
Comma-separated folders searched for that JDK, absolute or under ~, with * for any one folder name; @ stands for the operating system's usual locations, and empty only checks the running JDK. Command line or ~/ only. |
jenesis. (JENESIS_) |
(unset) | A program run with the version as its last argument when no JDK on the search path matches, such as jenesis-jdk; a name is looked up on the PATH, a path is absolute or starts with ~. Command line, ~/ or the environment only, and an empty value runs none; the jenesis command sets the variable to its own jenesis-jdk, for the run it starts, where SDKMAN, mise or Scoop installed it and the variable is unset (see Building & running). |
What a daemon saves is compiling speed, not setup. A Jenesis build has no script to parse - the project is
described by pom. or module-info. and configured by properties files - so nothing parsed or
compiled is held between calls. What is held is a warm JIT, and a build spends its time inside javac, which
a JVM that has already compiled a few modules runs faster. The daemon therefore pays in proportion to how
much a build compiles: nothing on a build that compiles little, where the socket costs more than the warm
code saves, and about a third off a five-module project. Compiling the build sources once, which is on by
default, is what removes the large fixed cost; the daemon is the increment after that. A daemon also sets
jenesis. to daemon, which keeps the JVMs that run a plugin's tools for the next call and the next build, so a
build that lints or generates in every module gains more from it than from a warm JIT alone.
Only jenesis. properties travel with a call to a daemon, which clears and sets them again around every
build. Everything a running JVM cannot change is the daemon's identity instead - the engine, the JVM, its
options, the environment and the project - and a call differing in one of them is handed to another daemon
rather than being served by one configured for something else. Daemons are shared: every project whose
build runs the same engine on the same JVM with the same options and environment builds in a daemon that is
free, which runs in a folder of its own. A relative path in a setting names a path relative to the project
root, with or without a daemon, and every process a build starts - a test JVM, a tool's warm JVM - runs in the
project's root, so a build means the same in a shared daemon as without one; a plugin that resolves a path
against the working directory rather than against the folders it is handed resolves it in the daemon's folder.
At most three daemons run at once on a machine, and starting one more first stops the one used least recently,
once it has finished the build it is running. jenesis. keeps a daemon for one project
alone, started in its root. On Windows, a folder a process runs in can be neither deleted nor renamed, so the
project's folder then stays in use for as long as its daemon runs, idle or not; --stop frees it.
| Property | Default | Effect |
|---|---|---|
jenesis. |
true |
Hand the build to a daemon any project may use that runs the same engine on the same JVM with the same options and environment, running in a folder of its own; false keeps a daemon for this project alone, started in its root. |
jenesis. |
3 |
How many daemons may run at once on the machine, across every project. Command line or ~/ only. |
jenesis. |
10800 |
Seconds of idleness after which a daemon exits. Command line or ~/ only. |
jenesis. |
(the client's) | JVM options for the daemon process itself, whitespace separated. Unset, a daemon starts with the -X, -D and -ea options of the JVM that hands it the build, so java -Xmx4g build/ builds in a daemon with four gigabytes. Command line or ~/ only. |
jenesis. |
~/ |
Where daemons announce themselves, each with its log, beside a copy of every engine compiled from source that one runs, relative to the folder the command runs in on the command line and to ~/ in ~/ or its profiles. Command line or ~/ only. |
A daemon runs build after build in one JVM, several projects' builds unless daemons are kept per project, and a build
runs code its project chose - its plugins, its
annotation processors, the tools it names - which can change what the whole JVM does. So after every build a
daemon restores the system properties, the default locale and the default time zone, and it ends after a build
that changed a JVM-wide default it cannot restore - the security providers, the default TLS context, socket
factory and host name verifier, authenticator, proxy selector, cookie handler, response cache or uncaught
exception handler, or the standard input - with a [DAEMON] line naming it; the next build starts a fresh
daemon. That keeps one build's settings out of the next. It is no boundary between builds: no JVM can
confine the code it runs, so code that sets out to outlast its build - a thread left running, a field changed
by reflection - reaches the daemon's later builds. A release that publishes never runs in a daemon unless a mode
says so. Shared daemons are for projects you trust alike; keep a project apart with -Djenesis., and
build a project you do not trust with -Djenesis., or in a container (jenesis.),
which also keeps it from your files.
An ahead-of-time cache answers the same cost without a process. It is a file of the engine's classes, already
loaded and linked, which a starting JVM maps instead of loading them again: nothing stays resident between
builds, there is no idle timeout, and the cache survives a reboot. The first build with jenesis.
trains it, which takes a build of a few seconds and some 20 MB on disk, and every later build starts from it.
It applies where the engine runs compiled, as the installed jenesis command runs it, which is where it saves
the most - a no-op build of a one-class project falls from 0.69 to 0.43 seconds. From the classes in
., a build packs them into a jar and starts a second JVM that can use the cache, which keeps
less of the saving. The engine in source mode is out of its reach, because java build/ runs in a
JVM that started before the cache could be named. The jenesis-make tool, which runs inside another program's JVM,
refuses it.
The same setting gives the tools a build forks caches of their own, by setting jenesis. to aot, in
source mode as well. A plugin's tool that
would start a JVM for every call - a linter, a formatter, a code generator - trains a cache on its first run and
starts from it on every later one, for as long as its jars, the JVM and its options stay the same. In the
code quality demo, the runs of google-java-format and forbiddenapis fall by more than half and those of PMD and
SpotBugs by about a third, while the first run of each takes a few seconds longer to train. The daemon keeps
those JVMs warm instead, so under it no tool trains a cache.
Every cache lives in one folder, .: the engine's, and one subfolder per tool and version, which
holds links to the tool's jars rather than copies. aot. in it records the engine and the JVM the
folder was started for, so a changed engine or an upgraded JDK clears the whole folder at once and every cache is
trained again; the folder may also be deleted by hand at any time. help, skill,
prompt, configuration and properties only print, so they neither train nor use a cache. The daemon keeps a warm JIT
the cache does not, so it stays ahead in a tight edit-build loop on a large project; where builds are frequent
and small, or a machine builds many projects now and then, the cache is the better trade.
On a CI server, where every run starts on a fresh machine and nothing lives on to be reused, the cache is the
mode to choose: the server's own cache keeps . between runs, and every run after the first starts
from a trained engine and trained tools. A tool's cache names its jars by path, size and modification time, so
the local repositories it resolved them into are kept beside it - ~/ and, where the build reads
Maven's, ~/ - and the server's cache has to restore files where and as it saved them, as
actions/ on GitHub Actions does. The engine starts from its cache only when it runs compiled, so the job
compiles it once and runs it from .:
- uses: actions/cache@v4
with:
path: |
.jenesis
~/.jenesis
~/.m2/repository
key: jenesis-$-$
restore-keys: jenesis-$-
- run: java build/jenesis/Make.java help
- run: java -Djenesis.make.mode=aot -cp .jenesis/classes build.jenesis.Make
Each run saves what it trained under a key of its own and restores the latest of the ones before; a changed engine or another JDK clears the folder, so a restored cache never serves a build it was not trained for. The engine's cache holds what its JVM loads before the build's own code runs, so a plugin's code, loaded into that JVM later, is not in it, while every tool a plugin starts in a JVM of its own gets a cache of its own.
A native image of the engine goes one step further: the engine starts as an executable, without a JVM.
jenesis. needs Make to run on the java of a GraalVM 25.5 or newer, whose
native-image compiles it:
$GRAALVM_HOME/bin/java -Djenesis.make.mode=native build/jenesis/Make.java
The first build runs on that GraalVM's JVM under its tracing agent, which records what an image of the engine
needs, and then compiles the image into ., which takes some minutes. Every later build runs
the image, with javac inside it, and starts every tool it forks from an ahead-of-time cache, as
jenesis. sets jenesis. to aot unless it is set. A compilation with annotation
processors forks javac as well, so that the processors run on a JVM.
jenesis. runs those forked JVMs from native images of their own instead: a tool, a test JVM or a
forked javac. Each image is compiled by the native-image beside the JVM the call names, once its first call, run on
that JVM under the tracing agent, has ended, and is kept in jenesis., keyed on the JVM, its options and
the content of the jars. A call reaching what that first call never reached fails the build, as does a command line
an image cannot run - one naming no main class, a source launcher, or a JVM option an image cannot carry - which
names jenesis. instead.
Where no build the agent watched loaded a plugin, the image holds the engine alone and is about 75 MB. Where one did - a plugin the project names, or an official plugin such as Checkstyle - the image is compiled with GraalVM's experimental runtime class loading. It then loads each plugin from its jars as a JVM does, a plugin added later included. Such an image keeps the JDK modules a plugin can reach whole and is about 320 MB; a plugin reaching another module of the JDK stops it with a fatal error.
A plugin added to a project whose image holds the engine alone fails that build, and the next build trains an image
that loads plugins. Any other build reaching something the agent never recorded fails like any build does. The image
is compiled again once the engine changes, or after the native folder of jenesis. is deleted.
| Property | Default | Effect |
|---|---|---|
jenesis. |
. |
The folder of every cache, the engine's and the tools', relative to the folder the command runs in on the command line and to the project root in a file. A project's own file names only a location inside the project. |
jenesis. |
(unset) | An ISO-8601 age, such as PT12H or P7D, after which the folder is cleared and every cache in it trained again; unset keeps it until the engine or the JVM changes. |
| Property | Default | Effect |
|---|---|---|
jenesis. |
$HOME |
Base folder whose . subfolder holds the user-global jenesis., relative to the folder the command runs in; empty string disables it. Command-line only. |
jenesis. |
(derived) | The settings the project's own files supplied, comma-separated and named without the jenesis. prefix. Make derives it, and no file may set it; it is how a repository or cache that a project's file named is never sent a credential, how a setting only you may make is refused there, and how a path named there resolves against the project root. |
jenesis. |
(derived) | The settings your user-global file and its profiles supplied, likewise, so that a path of the machine named there resolves against jenesis.. |
jenesis. |
(derived) | The . folder holding your user-global file. No file may set it. |
jenesis. |
(derived) | The settings the command line supplied, likewise, so that a path named there resolves against jenesis.. |
jenesis. |
(derived) | The folder the command runs in, which a relative path on the command line resolves against. The command and the tools record it, a daemon or a container keeps the one it is handed, and no file may set it. |
jenesis. |
(derived) | The file in the native folder of jenesis. that a build loading a plugin creates. Make names it for the builds that train a native image and for an image that holds the engine alone, so that the next build trains an image that loads plugins. Command-line only. |
jenesis. |
build. |
Comma-separated project-wide configuration folders; @ splices the default back in, and @<name> splices what jenesis. or the environment variable <name> holds. |
jenesis. |
the configuration folders | Path-separated list of folders searched for pin-<name>. files. |
jenesis. |
. |
The project-local folder resolved artifacts are materialised into (hard-linked from ~/ where possible), in every layout. It also holds a copy of each repository's maven-metadata., so a RELEASE or range still resolves when the repository is unreachable. A project's own file names only a folder inside the project. |
Building & testing
| Key | Default | Effect |
|---|---|---|
jenesis. |
false |
Register no test steps, so no tests run. Naming the key with no value is true; = runs the tests. |
jenesis. |
(unset) | Comma-separated [<module>/ list; runs only matching tests, in place of the default naming and of its JUnit 4 check that a class holds tests. An entry naming a module's folder applies to that module's tests alone, and a test module no entry reaches runs none. |
jenesis. |
(unset) | Comma-separated [<module>/ list, each matched against the whole class name; leaves the matching classes out of what the default naming or jenesis. selects. A test module whose every selected class is left out runs none. |
jenesis. |
(unset) | Tests to run by tag, in a framework-neutral syntax that needs no quoting on a command line: comma-separated alternatives, a test running where it matches any of them, each a tag, several joined by + for the tests carrying all of them, and -<tag> for the tests not carrying it; translated for the test framework. A run remembers what it covered until the tests' inputs change, so a later selection runs only what no earlier run did (see Code quality & testing). |
jenesis. |
false |
Run tests in parallel where the framework supports it. |
jenesis. |
0 |
The most test runs, each a forked JVM, that execute at once across the build while every other step keeps running; 1 runs one module's tests at a time, as Maven does, and 0 leaves them bounded by jenesis. alone. A negative number is refused. |
jenesis. |
false |
Write a test run's reports into the module's reports/: the legacy JUnit XML and the Open Test Reporting XML for junit-platform, TestNG's own report for testng. A failed run names the folder that holds them. Without it, junit-platform writes no report. |
jenesis. |
alphabetic |
Which tests run and in which order: alphabetic runs every test by class name, incremental only those a change reaches since the last successful run, prioritized those first and every other test after them, failed only the classes that failed in the run before, failedfirst those first and every other test after them, both on the JUnit Platform and TestNG. A jenesis., jenesis. or jenesis. switches incremental off. |
jenesis. |
true |
Run the tests against the packaged test jar; false runs them against the module's classes and resources folders instead, so a test can read its own resources as files, while the modules it depends on stay jars. A module tested on the module path refuses false. |
jenesis. |
false |
true runs the tests even when nothing changed and the recorded scope already covers the request. |
jenesis. |
1980-02-01T00:00:00Z |
The date and time recorded on every entry of the jars, jmods and zips the build produces; an ISO-8601 date-time with an offset between 1980-01-01T00:00:02Z and 2099-12-31T23:59:59Z. Empty turns the fixed time off, which is discouraged (see Building & running). Set explicitly, it is also the created label of a generated Dockerfile (see Packaging). |
jenesis. |
false |
Stage the test modules, and the modules tagged @jenesis. that they require; otherwise a test module is unstaged, as stage= leaves a module. |
jenesis. |
true |
Emit a CycloneDX SBOM; set false to skip it. |
jenesis. |
(unset) | Licence the SBOM beside a native image records for the GraalVM that compiled it, as an SPDX identifier or a name; unset records none (see Supply-chain features). |
jenesis. |
META-INF/ |
Comma-separated jar entries taken as legal notices into a ., a linked or packaged image and beside a native image, from the module's jar and from each runtime dependency's jar; names match regardless of case and also with an extension, and an entry ending in / takes the folder below it (see Packaging). |
jenesis. |
true |
Run the licence check a licensing. activates; false skips it. |
jenesis. |
true |
Run the vulnerability check a vulnerability. activates; false skips it. |
jenesis. |
true |
Checkstyle, switched on by a checkstyle. naming its checkstyle. as configuration= or, where no configuration folder holds one, by a checkstyle. in a configuration folder; false leaves it out. |
jenesis. |
true |
PMD, switched on by a pmd. naming its pmd. as configuration= or, where none is found, by a pmd. in a configuration folder; false leaves it out. |
jenesis. |
5 |
The lowest rule priority the PMD plugin runs, from 1, the highest, to 5, the lowest, as maven-pmd-plugin's minimumPriority; any other value is refused. |
jenesis. |
true |
detekt, switched on by a detekt. naming its detekt. as configuration= or, where none is found, by a detekt. in a configuration folder; false leaves it out. |
jenesis. |
true |
ktlint linting the Kotlin sources, switched on by a ktlint. naming its . as configuration= or, where none is found, by an . in a configuration folder; false leaves the linting out, as jenesis. does the formatting. |
jenesis. |
true |
Scalastyle, switched on by a scalastyle. naming its scalastyle-config. as configuration= or, where none is found, by a scalastyle-config. in a configuration folder; false leaves it out. |
jenesis. |
true |
scalafmt checking the Scala sources, switched on by a scalafmt. naming its . as configuration= or, where none is found, by a . in a configuration folder; false leaves the check out, as jenesis. does the formatting. |
jenesis. |
true |
CodeNarc, switched on by a codenarc. naming its codenarc. as configuration= or, where none is found, by a codenarc. in a configuration folder; false leaves it out. |
jenesis. |
true |
SpotBugs, switched on by a spotbugs., which may name an exclusion filter as configuration=, or, where none is found, by a spotbugs-exclude. in a configuration folder; false leaves it out. |
jenesis. |
true |
forbiddenapis, switched on by a forbiddenapis.; false leaves it out. |
jenesis. |
true |
jdeps --jdk-internals, switched on by a jdeps.; false leaves it out. |
jenesis. |
true |
jdeprscan, switched on by a jdeprscan.; false leaves it out. |
jenesis. |
false |
true fails the build on what the tool finds, where it otherwise records its findings: a violation Checkstyle, PMD, detekt, ktlint or Scalastyle exits reporting, a source scalafmt would format differently, any finding of CodeNarc, SpotBugs or forbiddenapis, a JDK internal API the classes use for jdeps, a use of an API deprecated for removal for jdeprscan, and a difference reaching its severity for revapi. |
jenesis. |
true |
The licence header check a licenseheader. activates, with its text or, without one, SPDX lines naming the declared licence and copyright. |
jenesis. |
false |
Rewrite sources in place instead of verifying. |
jenesis. |
true |
OpenRewrite, switched on by an openrewrite. naming a rewrite. as configuration=, whose recipes it runs, or recipes as recipes=, or, where none is found, by a rewrite. in a configuration folder; it runs before the Java formatter and reads the module's dependencies. |
jenesis. |
true |
google-java-format, switched on by a googlejavaformat. whose lines are its options; refused beside another Java formatter. |
jenesis. |
true |
palantir-java-format, switched on by a palantir. whose lines are its options; refused beside another Java formatter. |
jenesis. |
true |
open-java-format, switched on by an openjavaformat. whose lines are its options; refused beside another Java formatter. |
jenesis. |
true |
The Prince of Space formatter, switched on by a princeofspace. whose lines are its options; refused beside another Java formatter. |
jenesis. |
true |
Spotless, switched on by a spotless. naming sets of files of a module's sources and resources and the Spotless steps each set runs; a set running a Java, Kotlin or Scala formatter or licenseHeader is refused beside that tool's own file. |
jenesis. |
true |
The Eclipse formatter, switched on by an eclipse., which may name the profile Eclipse exports as configuration=, or, where none is found, by an eclipse-formatter. in a configuration folder; refused beside another Java formatter. |
jenesis. |
true |
ktlint formatting the Kotlin sources, switched on by what switches its linting on; false leaves the formatting out while ktlint still lints, as where ktfmt formats them. |
jenesis. |
true |
ktfmt, switched on by a ktfmt., which names its style and what it does to the imports; refused beside ktlint formatting the same sources. |
jenesis. |
true |
scalafmt formatting the Scala sources, switched on by what switches its check on; false leaves the formatting out while scalafmt still checks them. |
jenesis. |
true |
Run the GraalVM tracing agent when a graal. is present. |
jenesis. |
true |
Record the test JVM with Java Flight Recorder when a jfr. is present. |
jenesis. |
true |
Run the JaCoCo plugin when a jacoco. is present. |
jenesis. |
true |
Profile the test JVM with async-profiler when an asyncprofiler. is present, whose lines are the profiler's options. |
jenesis. |
true |
Run the PIT plugin when a pitest. is present. |
jenesis. |
true |
Run the japicmp plugin when a japicmp. is present. |
jenesis. |
true |
Run the revapi plugin when a revapi. is present; jenesis. decides whether a difference fails the build. |
jenesis. |
true |
Write a Maven plugin's META-INF/ into the module's classes from the mojos they declare, with Maven's own plugin tools, when a mavenplugin. is in the module's configuration folder (see Publishing). |
jenesis. |
true |
Stage, for every plugin a staged jar declares in META-INF/, the marker POM that Gradle resolves the plugin ID by, when a gradleplugin. is in the project's configuration folder (see Publishing). |
jenesis. |
true |
Write META-INF/ files, and Enable-Native-Access for a module granting itself, from module-info when a classpath. is present - see A modular jar on the class path. |
jenesis. |
true |
Run the generator plugin its file activates - xjc, protoc, avro, wsimport, openapi, antlr or ksp, each by a <tool>.; false leaves it out. |
jenesis. |
false |
Compile Kotlin incrementally through the Kotlin Build Tools API, which needs Kotlin 2.3 or newer, in the JVM the build's compilations share; see Other JVM languages. |
jenesis. |
false |
Compile Scala incrementally with Zinc, in the JVM the build's compilations share. |
jenesis. / . / . / . |
true |
Resolve the official plugin of the language where a module holds a ., ., . or . source; false leaves it out, and such a source then fails the build. |
jenesis. |
(unset) | Record each module's ABI as an abi. with one hash per class file: modular for the public and protected members of the packages a module exports, classpath for every package with its package-private members as well. A module whose required modules changed only below their ABI is not compiled again; a test module compares the module it tests by every package with its package-private members; unset records none and compiles every dependent again - see Recording a module's ABI. |
The quality and packaging files these keys gate (jdeps., packaging., and the like)
are covered in Code quality & testing, Generating
sources, Supply-chain features, and
Packaging.
Dependencies & pinning
| Key | Default | Effect |
|---|---|---|
jenesis. |
(lenient) | Pinning mode: strict, versions, or ignore. |
jenesis. |
none |
Signature verification after each download: none, declared, or strict. |
jenesis. |
ignore |
What to do when a module runs a jar whose Jenesis-Native-Access names a module it does not grant with @jenesis.: ignore, warn, or strict. |
jenesis. |
keep |
Whether the pin step keeps (keep) or flattens (flatten) BOM references. |
jenesis. |
(unset) | Write the pins of the groups jenesis. names, from every module, to this properties file, and every other group's to the module declarations. A project's own file names only a folder inside the project. |
jenesis. |
main |
Comma-separated groups whose pins jenesis. writes to the file, or * for every group. A module importing the file into one of them loses that group's pin lines from its declaration. |
jenesis. |
true |
Whether pin writes SHA checksums alongside versions. |
jenesis. |
groups |
Which lines a refresh keeps although it did not write them: groups those of a group the run resolved nothing in, all every one (a project built in more than one layout), none none. |
jenesis. |
(unset) | Comma-separated pin files, relative to the folder the command runs in on the command line and to the project root in a file, whose entries the file jenesis. names leaves out where the version and the checksum are the same. |
jenesis. |
(processor count) | How many modules' pins pin rewrites at once; 0 is unbounded. |
jenesis. |
(detected) | Add (=) or remove (=) a platform token used to select guarded pins. |
jenesis. |
(unset) | What a value @<key> or @<key>/ in a process-<command>., environment-<command>. or plugin-<name>. stands for; part of the input of every program it reaches (see Building & running). |
jenesis. |
true |
false leaves out the plugin <name> that jenesis. names (see Extending the build). |
jenesis. |
true |
false leaves out every plugin that jenesis. names, while pin still pins those of the whole project (see Extending the build). |
jenesis. |
SHA-256 |
Digest algorithm the pin step uses to checksum artifacts. |
jenesis. |
gpgv |
Binary forked to verify detached OpenPGP signatures. A name is looked up on the PATH; a value containing a separator is used as a path. Command line or ~/ only. |
jenesis. |
signing |
What an expired signing key means: ignored accepts it whenever it signed, signing accepts what it signed before it expired, current always rejects it. |
jenesis. |
(the configuration folders) | Path-separated locations searched for a local signature-<name>. key list. |
jenesis. |
(the trust root the tool carries) | The Sigstore trust root a bundle is checked against. Jenesis carries the published root of the public instance as source; naming another replaces it, for a private instance or a root that has rotated. Command line or ~/ only. |
jenesis. |
github. |
Comma-separated <host>= pairs for identity hosts whose OpenID Connect issuer is not the host itself. Both sides are written without a scheme. Command line or ~/ only. |
jenesis. |
maven |
Maven version strategy: maven, closest, latest, release, stable, fail, or managed. fail refuses a coordinate two dependencies require at different versions; managed refuses that and every version the project neither declares nor names in dependency management. |
jenesis. |
first |
What happens when two module descriptors record different versions: first, fail, ignore, or managed. managed additionally refuses a module reached through another module's requires that carries no pin. |
jenesis. |
true |
Resolve the compile, provided, runtime and test dependencies a pom. module declares as one graph, as Maven does, so a test or runtime dependency decides which version of a shared library the main classes compile and run with. false resolves each class path on its own (see Test dependencies and the main class path). |
Repositories
| Key (env fallback) | Default | Effect |
|---|---|---|
jenesis. (MAVEN_) |
Maven Central | Upstream Maven repository URL(s); supports filters and references. A project's own file may name them, and jenesis. is then not sent. An empty value names no upstream at all, so only Discovery and the artifacts a build stored answer. |
jenesis. (MAVEN_) |
~/ |
Local Maven repository for reads and export, relative to the folder the command runs in on the command line and to ~/ in ~/ or its profiles. Empty keeps no local Maven repository: everything resolved is kept in the project's . alone, and export refuses to run. Command line or ~/ only. |
jenesis. (MAVEN_) |
(unset) | Authorization header sent to the Maven upstream. Command line or ~/ only. It travels only to a jenesis. named in the environment, on the command line or there, never to the built-in public repository. |
jenesis. |
true |
Carry the POM and a pom. in the jar under META-INF/, as Maven does, where the layout publishes to Maven (see Publishing). |
jenesis. |
(unset) | Folders beside src/ and src/ that a pom. module compiles as well, comma-separated names such as kotlin,groovy, each read as src/ and src/ where it exists. |
jenesis. |
2 |
How many leading dot-separated segments of a module name form its Maven group ID when a module is published or resolved by the coordinate convention; a name with fewer becomes the group ID whole. A maven:<segments>:<uri> entry of jenesis. sets it for that remote alone. |
jenesis. (JENESIS_) |
https:/ |
The Jenesis Module Index URL(s) module names resolve through; same list/filter/@ grammar. An entry may name how it is read: maven:[<segments>:]<uri> reads a Maven repository by the publishing convention, and mapped:<uri or @>:<list>[;<list>. reads the modules that . lists, each a URI or an absolute path, map to <groupId>/, from the Maven repository at that URI or, for @, from the one jenesis. configures. A project's own file may name them, and jenesis. is then not sent. An empty value names no index at all, so only Discovery, the local module repository (~/) and the artifacts a build stored answer. |
jenesis. (JENESIS_) |
~/ |
The local module repository, read first, written by export and keeping each versioned module, artifact and POM a module remote served under <module>/, so an offline build of a fresh checkout finds what a module name resolved to; relative to the folder the command runs in on the command line and to ~/ in ~/ or its profiles; it also keeps the answers of discovery under well-known/. Empty keeps no local module repository: everything resolved, and every answer of discovery, is kept in the project's . alone, and export refuses to run. Command line or ~/ only. |
jenesis. |
service |
Who resolves a module name: service asks the index at jenesis., git reads its published data itself and fetches from jenesis.. |
jenesis. (JENESIS_) |
data/ in jenesis/ |
Where git reads that data from - a fork or mirror of the index's per-module files. |
jenesis. |
(unset) | Whether a module asked for without a version may resolve to a pre-release. Unset states no preference: the newest release is served, and a module that has only pre-releases resolves to nothing. |
jenesis. |
(unset) | Whether a version the index has not recorded may be resolved from the module's newest coordinate. Unset states no preference, and the version is guessed. |
jenesis. (OPENPGP_) |
keyserver., keys. |
HKP key server roots a declared fingerprint resolves through; same list/@ grammar, asked in order. A project's own file may name them. |
jenesis. (OPENPGP_) |
. |
Where fetched keys are held, one file per fingerprint, relative to the folder the command runs in on the command line and to the project root in a file; an empty openpgp. makes this the only source. A project's own file names only a folder inside the project. |
jenesis. (JENESIS_) |
(unset) | Authorization header sent to the module index. Command line or ~/ only. It travels only to a jenesis. named in the environment, on the command line or there, never to the built-in public repository, and only to the first of several. |
jenesis. |
false |
Permit plaintext (http:/) repositories, and over https accept a certificate that does not verify, such as a self-signed one. Command line or ~/ only. |
jenesis. |
2 |
Retries for a transient fetch failure (0 disables). |
jenesis. |
125 |
Initial retry wait in milliseconds, doubling each attempt. |
jenesis. |
10000 |
Connect timeout for a repository fetch, in milliseconds. |
jenesis. |
30000 |
Read timeout for a repository fetch, in milliseconds. |
jenesis. |
false |
Before the module and Maven repositories, read https:/ of the domain a module or Maven group is named after - see Discovery. |
jenesis. |
5000 |
Connect and read timeout, in milliseconds, for a domain's discovery file, which is asked once rather than with the retries of jenesis.; a domain that does not answer in time counts as publishing none for this build. A value that is not positive is refused. |
jenesis. |
24 |
Hours a domain's discovery answer - its file, or a 404 or 410 for none - is kept under well-known/ in the local module repository, or in the project's . where jenesis. is empty, so a later build reads it rather than asking again; 0 keeps nothing. Delete well-known/ to ask sooner. A local module repository that cannot be written is read alone. Command line or ~/ only. |
jenesis. |
false |
Download nothing. Modules, artifacts, checksums and keys come from ., the local Maven repository or a local module folder, and Maven metadata an earlier resolution stored answers a version range at the versions it named then. A fetch that would need the network fails the build with its URL named. No domain is asked for its discovery file, and what an earlier build kept of one is read whatever its age. The remote build cache is skipped, and a vulnerability lookup or a release fails the build. |
Caching
| Key (env fallback) | Default | Effect |
|---|---|---|
jenesis. |
(none) | Shared build cache: a file:/ or http(s):/ URI (see Build performance & isolation; Jenesis Repository is a reference cache server). Command line or ~/ only. |
jenesis. |
(off) | Project-local on-disk build cache (a path; empty enables .). A project's own file names only a folder inside the project. |
jenesis. (JENESIS_) |
(unset) | Project header sent to an HTTP cache. |
jenesis. (JENESIS_) |
(unset) | Auth key sent to an HTTP cache. Command line or ~/ only. |
jenesis. |
PT1S |
HTTP cache connect timeout, as an ISO-8601 duration. |
jenesis. |
PT10S |
HTTP cache read timeout, as an ISO-8601 duration. |
jenesis. |
false |
Permit the cache key over plaintext http:/, and over https accept a certificate that does not verify, such as a self-signed one. Command line or ~/ only. |
Running & containers
| Key | Default | Effect |
|---|---|---|
jenesis. |
(prompt) | The module to run with Execute.. |
jenesis. |
(inferred) | The main class to run. |
jenesis. |
false |
Build inside a throwaway container. Command line or ~/ only. |
jenesis. |
(hardened) | Image for the build container. Command line or ~/ only. |
jenesis. |
(none) | <host>[:<container>],… read-only bind mounts. Command line or ~/ only. |
jenesis. |
(none) | Writable bind mounts. Command line or ~/ only. |
jenesis. |
(none) | <name>[= environment forwarded into the container. Command line or ~/ only. |
jenesis. |
false |
Run the launched program in a container. Command line or ~/ only. |
jenesis. / readable / writable / env |
(as above) | The run-side equivalents. Command line or ~/ only. |
Releasing
Read by the release target - see Publishing.
| Key | Default | Effect |
|---|---|---|
jenesis. (JENESIS_) |
(unset) | The Jenesis module repository release puts each staged module into, with one put of its jar at module/, so every module needs a version: the https: address of a jenesis repository of a Jenesis Repository, the one jenesis. names; a java repository takes Maven publishes only and refuses the put. Unset, release puts nothing there. Its environment variable is not the one a build resolves through. |
jenesis. |
false |
Publish what a release puts and runs: the jenesis. and jenesis. puts and the plugins of release, JReleaser's without --dry-run. Without it, release and every pin run the release dry, checking what was staged and naming what it would put. Only the command line may set it. |
jenesis. |
true |
Run the JReleaser plugin where a configuration folder holds a jreleaser. naming its jreleaser. as configuration=, its other lines the plugin's values, or, where none is found, a jreleaser., ., . or .; false leaves it out. |
jenesis. (JENESIS_) |
(unset) | Authorization header sent to that repository, as given. Command line, ~/ or the environment only. It travels only to a jenesis. named in the environment, on the command line or there, never to one a project's own file named. Its environment variable is not the one sent to the resolving repositories. |
jenesis. (MAVEN_) |
(unset) | The Maven repository release puts the staged Maven tree into, every file at <group path>/ with its ., ., . and ., then each artifact's maven-metadata. merged with the one the repository holds; a -SNAPSHOT version under a unique timestamped name beside its own maven-metadata., as Maven deploys one. Nothing is signed, so a release to Maven Central goes through a jreleaser., while Central's snapshot repository takes a snapshot from here as any repository does. Unset, release puts nothing there. Its environment variable is not the one a build resolves through. |
jenesis. (MAVEN_) |
(unset) | Authorization header sent to that repository, as given, so it names its scheme, as Basic <credentials> or Bearer <token>. Command line, ~/ or the environment only. It travels only to a jenesis. named in the environment, on the command line or there, never to one a project's own file named. |
Read by the signing step - see Publishing. Naming any of them says the project signs its jar, and the build then stops rather than producing an unsigned one if the key store, the alias or the password location is missing.
| Key | Default | Effect |
|---|---|---|
jenesis. |
(unset) | The key store jarsigner signs the produced jar with, in place of the unsigned one, relative to the folder the command runs in on the command line and to ~/ in ~/ or its profiles. Command line or ~/ only. |
jenesis. |
(unset) | The name of the key within that store. Command line or ~/ only. |
jenesis. |
(unset) | Where that store's password is read from: env <variable> or file <path>, never the password itself; a path is read as the key store's is. Command line or ~/ only. |
jenesis. |
(unset) | The same, for a key that carries a password of its own. Command line or ~/ only. |
jenesis. |
(the JDK's own) | The store's type as jarsigner names it, normally PKCS12. Command line or ~/ only. |
jenesis. |
(unset) | A timestamp authority to stamp the signature with, so it outlives the certificate. Command line or ~/ only. |
jenesis. |
(unset) | Further jarsigner arguments, whitespace separated. Command line or ~/ only. |
Output & the execution engine
| Key | Default | Effect |
|---|---|---|
jenesis. |
ansi |
ansi colours what the build prints with ANSI escape sequences; none prints plain text. |
jenesis. |
true |
Per-step [STARTED]/[SKIPPED]/… lines; false runs silently. |
jenesis. |
true |
Print the Docker image a step is wrapped in. |
jenesis. |
false |
Print each external tool's command line. |
jenesis. |
false |
Stream every external tool's output; jenesis. targets one tool. |
jenesis. |
false |
Stream the test JVM's command and output. |
jenesis. |
true |
Print a [FINDINGS] line for each linter that found something, with the number of findings and where its report is. |
jenesis. |
false |
Print a [FETCHED] line per downloaded artifact. |
jenesis. |
false |
Print [LOADED]/[STORED] lines for the build cache, local and shared. |
jenesis. |
false |
Print a [VERIFIED] line per checked dependency with the key or the identity that signed it, [EXPIRED] with both dates where the key has since expired, and [UNDECLARED]/[UNSIGNED] for the ones no declaration covers. |
jenesis. |
false |
Append input/output checksums under each [EXECUTED] line. |
jenesis. |
false |
Print a [KEPT] line per pin a refresh kept although no closure resolved it. |
jenesis. |
false |
Print a [DIVERGED] line per coordinate the project pins at more than one version; divergence. is written either way. |
jenesis. |
false |
Print an [ALIAS] line per @jenesis. whose target already declares that module name. |
jenesis. |
true |
Name the steps that did not reproduce under jenesis., beside the summary line. |
jenesis. |
full |
What the dependencies selector prints: full or compact trees, or java, the arguments java runs each module but the test modules with, as the lines of an argument file (see Dependencies). |
jenesis. |
true |
Print one dependencies tree per module whose every node names the scopes it is resolved in; false prints one tree per module and scope. |
jenesis. |
false |
List the project's own modules among the resolved dependencies of the dependencies trees and count them in the licence and module summary. |
jenesis. |
false |
Show apart, under a heading naming each, the groups a module resolves for its build rather than for itself - a linter, a formatter, a plugin, an annotation processor - and count them in the licence summary. |
jenesis. |
true |
Include the test modules in the dependencies trees and their licence summary. |
jenesis. |
MD5 |
Digest for the per-file content and per-step config hashes. |
jenesis. |
PT0S |
ISO-8601 per-step timeout; PT0S disables it. |
jenesis. |
false |
Delete target/ first, forcing a full rebuild. |
jenesis. |
false |
Let independent step failures aggregate into one report instead of failing at the first. |
jenesis. |
true |
Write each step's outcome of the latest build to target/, one JSON object per line (see Building & running). |
jenesis. |
0 |
The most build steps that run at once across the whole build; 0 means no limit, while jenesis. still bounds the tools they run. |
jenesis. |
tool |
How JDK tool steps launch: tool (in-process) or fork; a -J option in process-javac. runs javac in a JVM of its own either way. |
jenesis. |
fork |
How a tool a plugin starts through ofJavaMain(), and javac where a -J option forks it, runs. fork starts a JVM for every call that jenesis. does not hand to a shared JVM, so a build without the daemon leaves no JVM running. aot starts that JVM from an ahead-of-time cache of the tool in jenesis., trained by its first run. native starts it from a native image of the tool in jenesis., which the native-image beside that JVM compiles once its first run, on the JVM under the tracing agent, has ended; a run reaching what that first run never reached fails the build, and so does a JVM option an image cannot carry. daemon runs it in one JVM that runs its compilations side by side, as it runs the calls a plugin marks shared, kept for the next call with the same jars on its class path, wherever a module resolved them, and the same options, environment and working directory; an idle one ends after ten minutes. jenesis. and jenesis. set it to the same unless it is set, and jenesis. sets it to aot. |
jenesis. |
(unset) | The working directory of every process the build starts, a test JVM and a tool's warm JVM included, relative to the folder the command runs in on the command line and to the project root in a file. Unset, it is the project root. A project's own file names only a folder inside the project. |
jenesis. |
true |
Run the calls a plugin marks shared, a compiler's above all, and javac where a -J option forks it, side by side in one JVM per JVM, options, jars and environment, under fork and aot as under daemon. The JVM ends with the build, unless jenesis. keeps it for the next one; false starts a JVM for every such call. |
jenesis. |
200 |
How many of the last lines of a failed tool's output and of its error the failure prints, beside how many there were and the file under supplement/ that holds all of them; 0 prints every line. |
jenesis. |
(processor count) | The most tool runs - a compiler, a JDK tool, a forked JVM such as a test run - that happen at once across the whole build; 0 means no limit. |
JAVA_ (env) |
(from java.) |
Locates the JDK binaries when the runtime is not a JDK. |
Built-in steps
A selector names a step by its identity. The build is a tree of these; the identities below are the ones you address on the command line. Each produces one output folder from its inputs, and its full behaviour is in the linked chapter.
Per module
| Step | Produces |
|---|---|
binary |
The Java toolchain for one module; its compiled, classes, validate, and artifacts steps sit beneath it. |
compiled |
Compiled classes from sources and the compile class path (javac, or a language compiler). |
classes |
The version-stamped classes exposed to downstream consumers. |
validate |
Byte-code analysis (jdeps and jdeprscan, as validate/, and plugins such as SpotBugs and forbiddenapis, as validate/). |
classpath |
The META-INF/ files and manifest attribute that let a modular jar run on the class path, when a classpath. is present (as classpath/). |
abi |
The abi. with one hash per class file, when jenesis. is set (as abi/). |
artifacts |
The packaged jar. |
check |
Static-analysis findings (Checkstyle, PMD, detekt, …). |
format |
Formatting verification, or an in-place rewrite. |
dependencies |
The resolved, fetched dependency closure. |
test (executed) |
The test run and its reports. |
observed |
The coverage- or trace-wrapped test run. |
compliance |
The licence and vulnerability check results. |
sbom |
The CycloneDX bill of materials. |
documentation |
The javadoc output, with that of a language plugin, and its jar. |
pom |
The emitted pom.. |
Packaging
Wired by keys in packaging. - see Packaging.
| Step | Produces |
|---|---|
legal |
The legal notices of the module's jar and its runtime dependencies, for its . and a native image. |
jmod |
A . link-time module. |
jlink |
A custom runtime image. |
jpackage |
A native installer or self-contained app image; with several types, every package jpackage lists. |
jpackage-<type> |
One type's package, where several types are built or the container image needs one jpackage does not list. |
bundle |
A self-contained bundle. of the application. |
launcher |
A single executable launcher jar (see Jenesis Launcher). |
docker |
A container build context - a Dockerfile and the jars it copies, or the jpackage package docker. names. |
native-image |
A GraalVM native executable. |
modules |
The dependency closure rewritten into explicit named modules (from modules.). |
Top level
The build, stage, export, release, and pin modules are the top-level targets in the table above;
each layout wires the maven and/or modular staging and export sub-steps under them. When a project names
plugins of the whole project, build also holds preprocess/, which runs before any module is built,
and postprocess/ and postprocess/, which run over every module after it is built,
while stage holds transform/ and inspect/ - with the stock staging then in staged/ and
each stage/ merging it with what the transforms of stage added - export and release hold
custom/ beside their own steps, and the top-level plugin holds a plugin of the hook point plugin as
plugin/, run only when named; stage/ holds what the transforms placed in the project (see Extending the
build).
Source declarations
Everything a module declares about its build is a Javadoc tag on module-info. - or, in the maven
layout, the POM equivalent named beside it. Tags are read from the module's documentation
comment in either form - the traditional / and the Markdown / of
JEP 467 - and pin writes back in whichever form the comment
already uses. This is the whole vocabulary:
| Tag | Declares | Chapter |
|---|---|---|
@jenesis. |
The Java release to compile against (maven. in a POM, and maven. for its tests where it names one); the running JDK's release when absent. <N>-preview also enables the preview features of that release, to compile and to run (maven. in a POM). |
Building & running |
@jenesis. |
The module's entry point (<mainClass> in a POM). |
Building & running |
@jenesis. |
Marks this module as the test module of another, or as test infrastructure that declares no tests of its own (abstract). A module carries one such tag; a second is refused, and any further module its tests need is a requires. |
Building & running |
@jenesis. |
An annotation processor, or a compiler plugin for a named compiler. | Other JVM languages |
@jenesis. |
A library to attach as a Java agent (<!--jenesis. in a POM). |
Building & running |
@jenesis. |
Native access for the modules named, this one only when it names itself; a module in a layer is granted with @jenesis. instead (<!--jenesis. in a POM). |
Building & running |
@jenesis. |
Transitives to prune from a requirement (<exclusions> in a POM). |
Dependencies |
@jenesis. or <module> <repository>/ |
A module name for an artifact that has none, resolved from the repository its target names. | Dependencies |
@jenesis. |
A module to replace with the modules that already carry its packages. | Dependencies |
@jenesis. |
The one module this module shares with the layer <name>. |
Dependencies |
@jenesis. |
A root the layer <name> isolates, with its whole closure: a module name or a <repository>/. Repeat for more roots. |
Dependencies |
@jenesis. |
Passes this module's native access on to a module of the layer <name>; this module then needs native access itself. |
Building & running |
@jenesis. |
An exact version and checksum (<!--jenesis. in a POM); a maven/ token with a checksum pins the POM read at that version, one line per version; a trailing (<token>,…) guard applies the line only on a matching platform. Parentheses, not brackets: a bracketed word is a link in a Markdown documentation comment. |
Pinning & bills of materials |
@jenesis. |
A bill of materials to import. | Pinning & bills of materials |
@jenesis. |
The OpenPGP key that signs these coordinates' artifacts; a Maven token may end in / to cover a whole group ID, and a lone [<group>/ reads the keys from a local list. |
Securing the supply chain |
@jenesis. |
The identity that signs these coordinates, for a repository that publishes a . beside the artifact. The path is a prefix of the identity a certificate names, and the host also names the issuer that must have authenticated it. |
Securing the supply chain |