Decorative site banner
Project icon

com.io7m.primogenitor

  • About
  • Releases
  • Manual
  • Sources
  • License
  • Issues
Maven Central Version Maven Snapshot Code Coverage

primogenitor

To build this project, you must use:

$ mvn -Denforcer.skip=true clean package

The reason for this is that this POM file is intended to be the root POM for io7m projects and uses the Maven Enforcer plugin to require that descendant projects define values for certain properties that this root POM leaves empty. Because there is no way in Maven to have a plugin applied only to descendants, the root POM actually cannot pass its own checks! Using the enforcer.skip property allows the root POM to be installed and deployed to repositories.

Features

The primogenitor POM builds on existing Maven conventions and enforces stricter conventions of its own. The POM is heavily commented and exposes several configurable properties. See the properties section in the POM for details.

The primogenitor POM is heavily biased towards extensive static checking, and the production of byte-for-byte reproducible builds.

By setting the parent of a project's POM file to com.io7m.primogenitor, the project receives the following services:

  • Generation of CycloneDX SBOMs.
  • Enforcement of the presence of POM properties required for Maven Central: Descendant POMs are required to provide description, url, and name elements.
  • Enforcement of a minimum Java version (currently 21) with a friendly error message if the project is built on a JDK that is too old.
  • Enforcement of a minimum Maven version (currently 3.8.2) with a friendly error message if the project is built with a version of Maven that is too old.
  • The immediate rejection of circular dependencies.
  • Enforcement of reproducible builds: No (transitive) dependency may depend on a SNAPSHOT version.
  • Enforcement of plugin versioning: No plugin may be added without an explicit version number.
  • Insertion of Git commit identifiers into the produced Jar file Implementation-Build manifest field with the buildnumber-maven-plugin. This assists with tracing exactly which artifacts were used to produce an application.
  • Byte-for-byte reproducible Jar files with the reproducible-build-maven-plugin. This may fail:
    • For JavaDoc jars, as the output of the javadoc tool is not deterministic.
    • If the project adds extra plugins that insert non-reproducible content into Jar files.
    • For SNAPSHOT versions of projects, as this will often result in various tools inserting the snapshot date and time into the Jar content.
  • Automatic insertion of OSGi metadata into the produced Jar files using the bnd-maven-plugin. Sensible default values are chosen based on metadata given in the POM file, and this can be overridden on a per-module basis.
  • Automatic checking of semantic versioning using the bnd-baseline-maven-plugin. Bytecode is analyzed and the build fails if, for example, binary incompatible changes have been made without incrementing the project's major version number.
  • Automatic source style checks using Checkstyle. Rules are consulted from external Maven artifacts in order to facilitate sharing rules across large numbers of projects and enforcing a consistent style everywhere.
  • Automatic production of JavaDoc and -sources Jar files, sufficient for publishing to Maven Central.
  • Automatic signing of artifacts with the maven-gpg-plugin, sufficient for publishing to Maven Central.
  • Incorporation of the nexus-staging-maven-plugin for publishing releases to Maven Central with a single mvn clean deploy command.
  • Analysis of dependency issues (unused dependencies, undeclared but used transitive dependencies) with the maven-dependency-plugin. The build fails if any dependency issues are discovered.
  • Generation of minimalist single page sites with minisite.
  • Automatic collection of code coverage information with JaCoCo.
  • All plugin versions are specified with Maven properties, and can therefore be overridden in the (unfortunate) case of a plugin being buggy, and can be efficiently updated with the versions-maven-plugin.
  • The ability to turn off all optional features and produce a build as quickly as possible by setting the property io7m.quickBuild to true on the command line: $ mvn -Dio7m.quickBuild=true clean package.

Releases & Development Snapshots

Releases

You can subscribe to the atom feed to be notified of project releases.

The most recently released version of the package is 9.0.0.

9.0.0 Release (2025-07-31Z)

  • Remove spotbugs. (Backwards incompatible) (Tickets: 60)
  • Remove io7m.useAlternateRepository. (Backwards incompatible)

The compiled artifacts for the release (and all previous releases) are available on Maven Central.

Maven Modules

<dependency> <group>com.io7m.primogenitor</group> <artifactId>com.io7m.primogenitor.lite</artifactId> <version>9.0.0</version> </dependency><dependency> <group>com.io7m.primogenitor</group> <artifactId>com.io7m.primogenitor.full</artifactId> <version>9.0.0</version> </dependency><dependency> <group>com.io7m.primogenitor</group> <artifactId>com.io7m.primogenitor.support</artifactId> <version>9.0.0</version> </dependency><dependency> <group>com.io7m.primogenitor</group> <artifactId>com.io7m.primogenitor.tests</artifactId> <version>9.0.0</version> </dependency>

Previous Releases

The changelogs for the most recent previous releases are as follows:

8.5.0 Release (2025-04-26Z)

  • Update org.codehaus.mojo:extra-enforcer-rules 1.9.0 → 1.10.0.
  • Update org.jacoco:jacoco-maven-plugin 0.8.12 → 0.8.13.
  • Update org.apache.maven.plugins:maven-surefire-plugin 3.5.2 → 3.5.3.
  • Update com.puppycrawl.tools:checkstyle 10.21.2 → 10.23.0.
  • Update org.ow2.asm:asm 9.7.1 → 9.8.
  • Update org.apache.maven.plugins:maven-clean-plugin 3.4.0 → 3.4.1.
  • Update org.apache.maven.plugins:maven-failsafe-plugin 3.5.2 → 3.5.3.
  • Update org.scijava:scijava-maven-plugin 3.0.0 → 3.0.1.

8.4.0 Release (2024-12-07Z)

  • Upgrade com.io7m.minisite 5.0.0 → 5.1.0.
  • Upgrade biz.aQute.bnd:bnd-indexer-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade biz.aQute.bnd:bnd-indexer-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade biz.aQute.bnd:bnd-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade biz.aQute.bnd:bnd-baseline-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade biz.aQute.bnd:bnd-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade biz.aQute.bnd:bnd-baseline-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade biz.aQute.bnd:bnd-resolver-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade biz.aQute.bnd:bnd-export-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade biz.aQute.bnd:bnd-export-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade biz.aQute.bnd:bnd-resolver-maven-plugin from 7.0.0 to 7.1.0
  • Upgrade com.github.spotbugs:spotbugs-maven-plugin from 4.8.6.5 to 4.8.6.6
  • Upgrade com.github.spotbugs:spotbugs-maven-plugin from 4.8.6.5 to 4.8.6.6
  • Upgrade com.puppycrawl.tools:checkstyle from 10.20.0 to 10.20.1
  • Upgrade com.puppycrawl.tools:checkstyle from 10.20.0 to 10.20.1
  • Upgrade org.apache.maven.plugins:maven-failsafe-plugin from 3.5.1 to 3.5.2
  • Upgrade org.apache.maven.plugins:maven-surefire-plugin from 3.5.1 to 3.5.2
  • Upgrade org.apache.maven.plugins:maven-javadoc-plugin from 3.10.1 to 3.11.1
  • Upgrade org.apache.maven.plugins:maven-javadoc-plugin from 3.10.1 to 3.11.1
  • Upgrade org.apache.maven.plugins:maven-surefire-plugin from 3.5.1 to 3.5.2
  • Upgrade org.apache.maven.plugins:maven-failsafe-plugin from 3.5.1 to 3.5.2
  • Upgrade com.puppycrawl.tools:checkstyle from 10.19.0 to 10.20.0
  • Upgrade com.puppycrawl.tools:checkstyle from 10.19.0 to 10.20.0
  • Upgrade com.puppycrawl.tools:checkstyle from 10.18.2 to 10.19.0
  • Upgrade com.puppycrawl.tools:checkstyle from 10.18.2 to 10.19.0
  • Upgrade org.apache.maven.plugins:maven-checkstyle-plugin from 3.5.0 to 3.6.0
  • Upgrade org.apache.maven.plugins:maven-dependency-plugin from 3.8.0 to 3.8.1
  • Upgrade org.apache.maven.plugins:maven-dependency-plugin
  • Upgrade org.apache.maven.plugins:maven-checkstyle-plugin
  • Upgrade com.github.spotbugs:spotbugs-maven-plugin from 4.8.6.4 to 4.8.6.5
  • Upgrade junit.version from 5.11.2 to 5.11.3
  • Upgrade org.codehaus.mojo:exec-maven-plugin from 3.4.1 to 3.5.0
  • Upgrade org.codehaus.mojo:exec-maven-plugin from 3.4.1 to 3.5.0
  • Upgrade junit.version from 5.11.2 to 5.11.3
  • Upgrade com.github.spotbugs:spotbugs-maven-plugin from 4.8.6.4 to 4.8.6.5

8.3.1 Release (2024-10-20Z)

  • Fix coverage generation. (Tickets: 128)

8.3.0 Release (2024-10-17Z)

  • Update org.cyclonedx:cyclonedx-maven-plugin:2.7.10 → 2.8.0.
  • Update junit.version:5.10.1 → 5.10.2.
  • Update org.apache.maven.plugins:maven-source-plugin:3.3.0 → 3.3.1.
  • Update org.jacoco:jacoco-maven-plugin:0.8.11 → 0.8.12.
  • Update org.apache.maven.plugins:maven-surefire-plugin:3.2.3 → 3.2.5.
  • Update org.codehaus.mojo:exec-maven-plugin:3.1.1 → 3.2.0.
  • Update org.apache.maven.plugins:maven-install-plugin:3.1.1 → 3.1.2.
  • Update org.ow2.asm:asm:9.6 → 9.7.
  • Update org.apache.maven.plugins:maven-deploy-plugin:3.1.1 → 3.1.2.
  • Update org.apache.maven.plugins:maven-jar-plugin:3.3.0 → 3.4.1.
  • Update com.puppycrawl.tools:checkstyle:10.12.7 → 10.16.0.
  • Update org.apache.maven.plugins:maven-gpg-plugin:3.1.0 → 3.2.4.
  • Update org.apache.maven.plugins:maven-failsafe-plugin:3.2.3 → 3.2.5.
  • Update org.apache.maven.plugins:maven-assembly-plugin:3.6.0 → 3.7.1.
  • Update org.codehaus.mojo:extra-enforcer-rules:1.7.0 → 1.8.0.
  • Update com.github.spotbugs:spotbugs-maven-plugin:4.8.2.0 → 4.8.5.0.
  • Update org.apache.maven.plugins:maven-shade-plugin:3.5.1 → 3.5.3.
  • Update com.puppycrawl.tools:checkstyle:10.16.0 → 10.17.0.
  • Update plugins.
  • Update org.apache.maven.plugins:maven-checkstyle-plugin 3.3.1 → 3.4.0.
  • Update org.apache.maven.plugins:maven-surefire-plugin 3.2.5 → 3.3.0.
  • Update org.apache.maven.plugins:maven-enforcer-plugin 3.4.1 → 3.5.0.
  • Update org.apache.maven.plugins:maven-javadoc-plugin 3.6.3 → 3.7.0.
  • Update org.apache.maven.plugins:maven-shade-plugin 3.5.3 → 3.6.0.
  • Update com.github.spotbugs:spotbugs-maven-plugin 4.8.5.0 → 4.8.6.2.
  • Update org.apache.maven.plugins:maven-jar-plugin 3.4.1 → 3.4.2.
  • Update org.apache.maven.plugins:maven-clean-plugin 3.3.2 → 3.4.0.
  • Update org.apache.maven.plugins:maven-failsafe-plugin 3.2.5 → 3.3.0.
  • Update org.scijava:scijava-maven-plugin 2.2.0 → 3.0.0.
  • Update org.apache.maven.plugins:maven-dependency-plugin 3.6.1 → 3.7.1.
  • Update org.apache.maven.plugins:maven-failsafe-plugin:3.3.0 → 3.3.1.
  • Update org.apache.maven.plugins:maven-surefire-plugin:3.3.0 → 3.3.1.
  • Update org.apache.maven.plugins:maven-javadoc-plugin:3.7.0 → 3.8.0.
  • Update org.cyclonedx:cyclonedx-maven-plugin:2.8.0 → 2.8.1.
  • Update org.codehaus.mojo:exec-maven-plugin:3.3.0 → 3.4.0.
  • Update org.codehaus.mojo:exec-maven-plugin:3.4.0 → 3.4.1.
  • Update org.apache.maven.plugins:maven-gpg-plugin:3.2.4 → 3.2.5.
  • Update junit.version:5.10.3 → 5.11.0.
  • Update org.apache.maven.plugins:maven-failsafe-plugin:3.3.1 → 3.4.0.
  • Update org.apache.maven.plugins:maven-surefire-plugin:3.3.1 → 3.4.0.
  • Update org.apache.maven.plugins:maven-install-plugin:3.1.2 → 3.1.3.
  • Update org.apache.maven.plugins:maven-deploy-plugin:3.1.2 → 3.1.3.
  • Update org.apache.maven.plugins:maven-failsafe-plugin:3.4.0 → 3.5.0.
  • Update org.apache.maven.plugins:maven-surefire-plugin:3.4.0 → 3.5.0.
  • Update com.puppycrawl.tools:checkstyle:10.17.0 → 10.18.0.
  • Update org.apache.maven.plugins:maven-javadoc-plugin:3.8.0 → 3.10.0.
  • Update com.puppycrawl.tools:checkstyle:10.18.0 → 10.18.1.
  • Update org.codehaus.mojo:buildnumber-maven-plugin:3.2.0 → 3.2.1.
  • Update com.github.spotbugs:spotbugs-maven-plugin:4.8.6.2 → 4.8.6.3.
  • Update io.github.zlika:reproducible-build-maven-plugin:0.16 → 0.17.
  • Update org.apache.maven.plugins:maven-gpg-plugin:3.2.5 → 3.2.6.
  • Update org.codehaus.mojo:extra-enforcer-rules:1.8.0 → 1.9.0.
  • Update com.github.spotbugs:spotbugs-maven-plugin:4.8.6.3 → 4.8.6.4.
  • Update junit.version:5.11.0 → 5.11.1.
  • Update org.cyclonedx:cyclonedx-maven-plugin:2.8.1 → 2.8.2.
  • Update org.apache.maven.plugins:maven-gpg-plugin:3.2.6 → 3.2.7.
  • Update com.puppycrawl.tools:checkstyle:10.18.1 → 10.18.2.
  • Update junit.version:5.11.1 → 5.11.2.
  • Update org.apache.maven.plugins:maven-failsafe-plugin:3.5.0 → 3.5.1.
  • Update org.apache.maven.plugins:maven-surefire-plugin:3.5.0 → 3.5.1.
  • Update org.ow2.asm:asm:9.7 → 9.7.1.
  • Update org.cyclonedx:cyclonedx-maven-plugin:2.8.2 → 2.9.0.
  • Update org.apache.maven.plugins:maven-checkstyle-plugin:3.3.1 → 3.4.0
  • Update org.apache.maven.plugins:maven-surefire-plugin:3.2.5 → 3.3.0
  • Update org.apache.maven.plugins:maven-enforcer-plugin:3.4.1 → 3.5.0
  • Update org.apache.maven.plugins:maven-javadoc-plugin:3.6.3 → 3.7.0
  • Update org.apache.maven.plugins:maven-shade-plugin:3.5.3 → 3.6.0
  • Update com.github.spotbugs:spotbugs-maven-plugin:4.8.5.0 → 4.8.6.2
  • Update org.apache.maven.plugins:maven-jar-plugin:3.4.1 → 3.4.2
  • Update org.apache.maven.plugins:maven-clean-plugin:3.3.2 → 3.4.0
  • Update org.apache.maven.plugins:maven-failsafe-plugin:3.2.5 → 3.3.0
  • Update org.scijava:scijava-maven-plugin:2.2.0 → 3.0.0
  • Update org.apache.maven.plugins:maven-dependency-plugin:3.6.1 → 3.7.1

Development Snapshots

At the time of writing, the current unstable development version of the package is 9.0.0-beta0003.

Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.

Manual

This project does not have any user manuals or other documentation beyond what might be present on the page above.

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/primogenitor

$ git clone --recursive https://www.github.com/io7m-com/primogenitor

Issues

This project uses GitHub Issues to track issues.

License

Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Last Updated 2025-08-09T12:41:30Z