Skip to content

DEPLOY.md

Latest commit

 

History

History
101 lines (76 loc) · 2.5 KB

DEPLOY.md

File metadata and controls

101 lines (76 loc) · 2.5 KB

Deployment Instructions

First the prerequisites

Prerequisites

Modern JDK installed and on PATH, ideally JAVA_HOME set

$ java --version
# Should output a version number that is at least 11

$ echo $JAVA_HOME
# some path

Maven should be installed and on PATH

$ mvn --version
# expecting >= 3.6.3

GPG is installed and on PATH (to sign packages for release to maven central)

$ gpg2 --version
# Could be just gpg on your system

Build etc

Navigate to project root (contains pom.xml and src/)

You don't need to run these all in order, they will call their prerequisite tasks. e.g package will run compile & test first

$ mvn clean # Cleans ./target dir
$ mvn compile # Builds project
$ mvn test # Runs tests
$ mvn package # Creates deployment artifacts in ./target
$ mvn install # Install packages to local maven cache e.g. ~/.m2/

Deployment to ossrh

We don't push directly to maven central, instead we push to ossrh and releases are synced from there to central.

To deploy to ossrh you will need to do the following

  1. Sign up to the ossrh Jira https://issues.sonatype.org
  2. Be granted privileges to deploy io.floodgate.sdk, raise issue or append to https://issues.sonatype.org/browse/OSSRH-58183
  3. create/update maven settings.xml ~/.m2/settings.xml (C:\Users\{name}\.m2\\settings.xml)
  4. add ossrh jira credentials
<settings>
    <servers>
        <server>
            <id>ossrh</id>
            <username>your_username_here</username>
            <password>your_password_here</password>
        </server>
    </servers>
</settings>

Additionally, packages require signing with a gpg key to verify Author.

$ gpg --list-secret-keys
# Should have entry for Floodgate <support@floodgate.io>

To deploy a snapshot to ossrh (version string ends in -SNAPSHOT in pom.xml)

$ mvn clean deploy

To promote release remove snapshot from version string

$ mvn versions:set -DnewVersion=x.x.x
$ mvn clean deploy

Verify everything OK with release using the staging repo before promoting to release repo If anything is wrong with the release you can drop from staging repo with

$ mvn nexus-staging:drop

If everything is OK you can promote release

$ mvn nexus-staging:release

All done, further details can be found at the following

  1. https://central.sonatype.org/pages/apache-maven.html
  2. https://central.sonatype.org/pages/ossrh-guide.html#deployment
  3. https://maven.apache.org/repository/guide-central-repository-upload.html