IKE Maven Plugin

The ike-maven-plugin provides the ike:* goal prefix — single-repo release orchestration, the release cascade, site deploy + publishing, scaffolding, native packaging utilities, and BOM generation. The AsciiDoc doc-rendering pipeline moved to ike-doc-maven-plugin (idoc:) in IKE-Network/ike-issues#437.

Coordinate Value
Group ID network.ike.tooling
Artifact ID ike-maven-plugin
Goal prefix ike:
Packaging maven-plugin
Java version 25

For workspace-spanning goals (ws:* prefix), see the ws plugin[1] in ike-platform. The two plugins are deliberately separate — ike:* is single-repo, ws:* fans out across a workspace’s checked-out subprojects.

Plugin shape

This is a regular Maven plugin — no <extensions>true</extensions>, no custom <packaging> type registered via META-INF/plexus/components.xml, no participation in the build extension realm. Goals look up at execution time, the plugin’s <version> interpolates from ${ike-tooling.version} like any other managed plugin, and consumers inherit the version through ordinary <pluginManagement> indirection.

This was not always the case. Earlier revisions registered the <packaging>ike-doc</packaging> custom type here (the stale components.xml removed per IKE-Network/ike-issues#320), which forced this plugin to be loaded as a build extension and consequently forced its <version> to be a literal string everywhere it was declared. That constraint was retired alongside the migration to a classifier-canonical doc shape — see the ike-tooling reactor home for the full design rationale, or IKE-Network/ike-issues#321 for the umbrella tracking issue.

What this means for plugin consumers: nothing changes about how you invoke ike:* goals. What changed is that the plugin no longer forces literal-version pins in your POM, and no longer contributes <packaging>ike-doc</packaging> to your reactor. Doc modules use <packaging>pom</packaging> (or <packaging>jar</packaging> for hybrids) plus an adoc classifier attachment; the activation is path-conditional on src/docs/asciidoc/ existence in ike-parent’s `doc-pipeline profile.

Goal naming convention

Most state-mutating goals come in a draft / publish pair:

mvn ike:release-draft        # report what would happen, write nothing
mvn ike:release-publish      # apply the changes

The bare goal name (e.g. ike:release) is wired to the draft variant. This is the same convention used by ws:* — every mutation is two-phase with a real chance to audit the draft before committing.

Read-only goals (e.g. ike:help, ike:env) have no draft/publish split — they are always safe.

Quick start — IntelliJ IDEA

Open the project in IntelliJ. The Maven tool window (right sidebar, View → Tool Windows → Maven if hidden) auto-discovers the ike:* goals from this plugin’s <pluginManagement> declaration in ike-parent. Both ike and ws (the workspace plugin) appear as top-level entries:

Maven tool window with ike + ws plugins

Expand the ike (network.ike.tooling:ike-maven-plugin:…​) entry to see all ike:* goals:

ike goals expanded in Maven tool window

Common interactions:

  • Run a read-only goal (ike:help, ike:env) — double-click the goal in the tree.
  • Run a goal with parameters (e.g. ike:site-publish with -Dsite=removed to uninstall) — right-click the goal → Modify Run Configuration… → fill Properties → Run.
  • Pin frequently-used invocations — once a Run Configuration is saved, it appears in the toolbar dropdown for one-click access.
  • Discover goals — ike:help prints the registry, but the Maven tool window has all goals visible by name without running anything.

For workspace-spanning operations, the same IntelliJ pattern applies to the ws:* plugin in ike-platform — see the ws plugin Quick Start[1].

Quick start — Command line

# Preview a release (writes a markdown report; no on-disk changes)
mvn ike:release-draft

# Execute a release: tag, deploy to Nexus + komet.sh + gh-pages,
# bump to next SNAPSHOT
mvn ike:release-publish

# Re-deploy the site for the current release without re-releasing
mvn ike:site-publish

# Apply scaffold convention upgrades
mvn ike:scaffold-publish

Quick reference

Goal Phase Purpose
release-{draft,publish} release Single-repo release: tag, deploy to Nexus + komet.sh + GitHub Pages, bump
verify-release-published release Verify all post-release publication targets (6 read-only HTTP checks)
site-{draft,publish} site Generate, deploy, and register the Maven site; -Dsite=removed uninstalls and deregisters
ike:generate-bom bom Auto-generate a BOM POM from another module’s dependency management
scaffold-{draft,publish,revert} scaffold Apply the workspace scaffold manifest (gitignore, hooks, IDE settings)
ike:inject-breadcrumb site Inject nav breadcrumbs into JaCoCo HTML reports
ike:adoc-union docs Unpack every declared topic library into one AsciiDoc union per repository, reactor members linked
ike:unpack-zip utility Download + unpack a zip from a URL
ike:rename utility Rename a file (replaces exec-maven-plugin calls to mv)
ike:codesign-natives native Sign native libraries inside a jlink runtime image (macOS notarization)
ike:codesign-pkg native Re-sign .app inside .pkg to add JVM entitlements
ike:jpackage-props native Compute build timestamp, platform, JPackage version properties
ike:notarize native Sign + notarize macOS installer packages (.pkg, .dmg)
release-cascade release Release the whole foundation in dependency order, repinning as it goes
release-changelog release Render a "What’s changed" changelog from a release’s commits and milestone
central-stage release Version-pinned Maven Central staging: consumer POMs, BOM swap, JReleaser upload
central-status release Report the status of asynchronous Maven Central deploys
announce-{draft,publish} announce Preview / post an announcement to a Zulip stream
build-report-ratchet-{draft,publish} report Tighten the build-report ledger’s accepted counts and measure bounds against the current build
built-with site Render a "Built With" page from the CycloneDX SBOM
render-sbom-viewer site Render a web-friendly SBOM viewer page from the CycloneDX SBOM
render-spdx-licenses site Render an SPDX-grouped licenses.adoc from the CycloneDX SBOM
inject-javadoc-theme site Overlay the IKE stylesheet onto a generated Javadoc tree
kb-assemble knowledge Assemble a knowledge base from ordered knowledge artifacts
knowledge-attach knowledge Attach produced knowledge artifacts to another reactor project
knowledge-bindings knowledge Generate the bindings class for a ledger-form knowledge set
knowledge-export knowledge Export a ledger-form knowledge set as a standalone protobuf artifact
knowledge-verify knowledge Verify a knowledge artifact in a pristine store (round-trip gate)
changeset-inspect knowledge Report what a change set is made of: format, entries, records by kind and pattern, references
changeset-verify knowledge Check a change set against its format; fail the build on any error
changeset-expand knowledge Rewrite a format-3 change set in the format-2 layout, references by UUID
changeset-compact knowledge Rewrite a format-1 or format-2 change set in format 3
schema-import knowledge Import an XML Schema as a ledger section, a node catalog (HL7 ELM first)
starter-set-create-{draft,publish} genesis Genesis of a new starter-set project
kb-create-{draft,publish} genesis Create a knowledge-base project from knowledge sources on a Maven repository
kb-remote-{draft,publish} genesis Give a knowledge-base project its remote: origin, the POM’s scm, and the push
cascade-export inspection Export the foundation release-cascade topology, machine-readable
env inspection Print runtime environment diagnostics
ike:help inspection Discover available ike:* goals

Release goals

ike:release-{draft,publish}

Full single-repo release in one command. The publish variant:

  1. Creates a release/<version> branch from current HEAD
  2. Sets the release version (strips -SNAPSHOT)
  3. Stamps project.build.outputTimestamp from the commit timestamp (reproducible builds)
  4. Runs mvn verify -B
  5. Tags v<version>
  6. Builds the site and deploys to scpexe internal site (/srv/ike-site/<projectId>/<version>/)
  7. Updates the latest symlink to point at the new version (ike-issues#303)
  8. Force-pushes the staged site to <repo>/gh-pages so it serves at https://ike.network/<projectId>/[2] via the org CNAME (ike-issues#312)
  9. clean deploy to Nexus (signed via Bouncy Castle)
  10. Pushes tag and main to origin
  11. Creates a GitHub Release (uses milestone-based notes if a matching <projectId> v<version> milestone exists)
  12. Cleans up the snapshot/main site
  13. Bumps to the next SNAPSHOT version

Failure recovery: re-run ike:release-publish and it picks up where the previous attempt left off (already-published phases are skipped).

If your reactor is the one that builds ike-maven-plugin (i.e., ike-tooling itself), see Self-host bootstrap pattern[3] for how the release flow’s site invocations sidestep the reactor cycle.

ike:verify-release-published

Verify that all six post-release publication targets are reachable for a given project + version. Read-only; exits non-zero on any check failure so it composes into shell pipelines and CI.

# Use pom defaults (artifactId + pom version with -SNAPSHOT stripped)
mvn ike:verify-release-published

# Explicit values (e.g., verifying from outside the released checkout)
mvn ike:verify-release-published -DprojectId=ike-tooling -Dversion=163

# Skip targets that aren't ready yet (e.g., immediately after tag push,
# before the org-site sync has had a chance to run)
mvn ike:verify-release-published -DskipOrgSite=true

Checks:

ike-issues#374.

mvn ike:release-draft                       # preview
mvn ike:release-publish                     # execute
mvn ike:release-publish -DskipVerify=true   # skip mvn verify (faster retry)

ike:release-cascade and ike:cascade-export

ike:release-publish releases one repo. The IKE foundation — ike-tooling → ike-docs → ike-platform — must release in order, because each consumes the artifacts of the ones above it. ike:release-cascade walks that order, releasing every foundation repo with unreleased changes; ike:cascade-export writes the cascade topology for a CI meta-runner. Both assemble the graph from each repo’s own src/main/cascade/release-cascade.yaml.

See The IKE Release Cascade[10] for the model, the manifest format, and how to test and run it.

Site goals

ike:site-{draft,publish}

Generate, deploy, and register the project’s Maven site in one converged goal (ike-issues#398). The publish variant builds the site, deploys it (version-prefixed directory + latest symlink + gh-pages push, matching what release-publish does for the site portion), and registers the project on the IKE-Network/IKE-Network.github.io org landing page (https://ike.network/[7]). Registration is part of the default flow — no separate goal.

Useful for re-deploying a site without re-releasing the artifact.

mvn ike:site-publish                              # deploy + register
mvn ike:site-publish -DupdateRegistration=false   # deploy only, skip org landing page
mvn ike:site-publish -DupdateSite=false           # registration only, no site deploy
mvn ike:site-publish -Dsite=removed               # uninstall: remove the deployed
                                                  # site directory and deregister

The -Dsite=removed form replaces both the old clean-site (stale snapshot/checkpoint cleanup) and deregister-site goals — uninstall includes stale-dir cleanup and org-index removal. Use ike:site-draft to preview any of these without writing.

BOM generation

ike:generate-bom

Generate a standalone BOM POM from another module’s <dependencyManagement>. The IKE BOM (network.ike.platform:ike-bom) is auto-generated this way from `ike-parent’s dependency management, ensuring the BOM never drifts from the parent’s version pins.

Scaffold goals

ike:scaffold-{draft,publish,revert}

Apply (or revert) the workspace scaffold — the conventional non-source files that every IKE workspace shares: .gitignore, git hooks under ~/.git-hooks/, .mvn/maven.config, IDE settings (.idea/, .vscode/). The scaffold manifest is shipped as the scaffold classifier of ike-build-standards.

scaffold-revert undoes a previous scaffold-publish per the tier policy in the manifest (some files are tool-owned and revertible, others are tracked in version control and not touched on revert).

Site goals

The AsciiDoc doc-rendering pipeline (asciidoc, render-pdf, adocstudio, fix-svg, patch-docbook, prepare-renderer-output, copy-default-pdf, copy-docs, scan-logs) moved to ike-doc-maven-plugin (idoc:) — see the idoc plugin[11]. The goal below stays in ike-maven-plugin: it does not render AsciiDoc.

ike:inject-breadcrumb

Inject navigation breadcrumbs and theme overrides into JaCoCo HTML reports so they fit visually with the rest of the Maven site.

Native packaging

These are macOS-specific signing / notarization goals used by Komet desktop builds.

ike:codesign-natives

Sign native libraries (.dylib, .jnilib) inside a jlink runtime image so the resulting installer passes Apple notarization.

ike:codesign-pkg

Re-sign the .app bundle inside a jpackage-produced .pkg installer to add macOS entitlements required by the JVM.

ike:jpackage-props

Compute ~19 Maven project properties (build timestamp, platform, JPackage version) consumed by JReleaser’s jpackage descriptor.

ike:notarize

Sign and notarize macOS installer packages (.pkg, .dmg). Automates the Apple notarization workflow.

Documentation goals

ike:adoc-union

Unpack every topic library the module declares, classifier adoc and type zip, into one AsciiDoc union per repository at <reactor root>/target/generated-sources/adoc, in the generate-sources phase. A library lays its root out as packages, <group>/<domain>/<topic>.adoc, and ships a manifest at META-INF/ike/<group>/<artifact>/manifest.yaml listing them. An external library is copied from its zip; a library that is a module of the same reactor is linked to its src/docs/asciidoc, so an edit reached through an include changes the real source. Two libraries that ship one package are refused, naming both. A zip without a manifest is a legacy library: refused unless -Dike.adoc.legacy=true, which unpacks it into the per-module directory as before. The goal is idempotent from every module, so a -pl build works, and it leaves an entry alone whose library no module declares anymore.

After unpacking it checks that every include::{adoc}/…​ and include::{topics}/…​ in the module’s src/docs/asciidoc resolves in the union. One that does not fails the build with the exact <dependency> block to add, found in the union’s manifests and then in the local repository; nothing is fetched. The project properties adoc and topics are set to the union so the asciidoctor plugin’s attributes can reference them. Design topic dev-adoc-packages in ike-lab-documents; IKE-Network/ike-issues#1342.

Parameter Default Purpose
ike.adoc.union <root>/target/generated-sources/adoc The union directory
ike.adoc.link true Link reactor members' package directories rather than copying them
ike.adoc.legacy false Unpack a zip without a manifest into the legacy directory rather than refusing it
ike.adoc.legacyDirectory ${project.build.directory}/generated-sources/asciidoc/topics-asciidoc Where a legacy library is unpacked
ike.adoc.sourceDirectory ${project.basedir}/src/docs/asciidoc The source root whose includes are verified
ike.adoc.verifyIncludes true Fail the build for an include that does not resolve
ike.adoc.skip false Skip the goal

Utility goals

ike:unpack-zip

Download and unpack a zip archive from a URL. Uses java.util.zip.ZipInputStream directly — bypasses unpack-dependencies when the source isn’t a Maven artifact.

ike:rename

Rename a file within a directory. Replaces exec-maven-plugin calls to mv in the doc pipeline.

ike:help

Print a list of available ike:* goals, generated from the compile-time IkeGoal registry. Goal names cannot drift from the actual plugin because the registry is enforced at compile time.

See also

Searching...
No results.