Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 3.31 KB

README.md

File metadata and controls

53 lines (42 loc) · 3.31 KB

Install Status Snapshot Status Release Status Maven Central

OSSRH Parent POM

An OSSRH parent POM file for deployment to Maven Central.

Installation

<parent>
  <groupId>tools.bestquality</groupId>
  <artifactId>ossrh-parent</artifactId>
  <version>0.0.17</version>
</parent>

Environment Variables

The following environment variables are expected to be available when deploying snapshot and release artifacts to OSSRH:

Name Type Description
CODE_SIGNING_KEY_FINGERPRINT string The fingerprint of the GPG public key used to sign the artifacts
CODE_SIGNING_KEY_PASSPHRASE string The passphrase associated with the code signing key

OSSRH Deployment Properties

The following project properties should be overridden from an inheriting POM file in order to deploy snapshot and release artifacts to OSSRH:

Name Type Description
ossrh.hostname string The hostname of your assigned Nexus Repository Manager instance, i.e. oss.sonatype.org
ossrh.staging-profile string The identifier of staging profile associated with your group coordinate

Project Properties

The following project properties should be overridden from an inheriting POM file:

Name Type Description
repository.slug string The slug of your GitHub repository in the following format: <GH_USERNAME>/<GH_REPO_NAME>

repository.slug

Maven Profiles

ossrh

Activating the ossrh profile will skip the built-in maven-deploy-plugin plugin and engage the maven-gpg-plugin to sign the project artifacts and the nexus-staging-maven-plugin to deploy the artifacts to OSSRH.

CI/CD

This parent works seamlessly with the CI Maven Actions and Workflows