Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 4.27 KB

CI-README.md

File metadata and controls

91 lines (63 loc) · 4.27 KB

Prerequisites

  1. Every release master (person allowed to manage releases), should do following: 1.1. Generate GPG pair for signing releases (please use password protection!) See Guide 1
    also Guide 2 1.2 Publish key on public servers via gpg2 --keyserver hkp://pool.sks-keyservers.net --send-keys <KEYID> 1.3. Register sonatype account
  2. The same operations (sonatype account and published GPG identity) should be done for CI bot (please create password-protected key, as suggested by default)
  3. Create a New Project ticket, requesting new project/namespace to be created. Mention all release masters and CI bot in a list of collaborators.
  4. For CI bot, generate travis-compatible version of the GPG key (use gpg2 to export ascii-armored secret key into the file first) : cat secret_key.ascii.gpg | python bin/multiline_input_to_travis_env.py > /tmp/travis_compatible_env_value.txt
  5. At least one account on https://hub.docker.com is needed, which credentials will be used to avoid hitting limits for anonymous docker pulls, often exceeded by Travis servers. It is recommended to use separate CI robot account for security purposes, as credentials would be stored (encrypted) on Travis side.

Configuration

Travis

Following environment variables need to be configured on a repository level:

  1. DOCKERHUB_USERNAME (visible) – any Docker Hub account, preferably CI bot’s.
  2. DOCKERHUB_PASSWORD (secret)
  3. ORG_GRADLE_PROJECT_ossrhUsername (visible) – Sonatype username for CI bot
  4. ORG_GRADLE_PROJECT_ossrhPassword (secret)
  5. ORG_GRADLE_PROJECT_signingKey (secret) – the exact contents of CI bot’s GPG key in a form suitable for Travis environment ( content of /tmp/travis_compatible_env_value.txt, generated above)
  6. ORG_GRADLE_PROJECT_signingPassword (secret) -- passphrase for bot's GPG key
  7. ORG_GRADLE_PROJECT_publishGroupId (optional, visible) – if releasing to the Maven namespace different from default com.appland

Developer environment

Export variable TRAVIS_BUILD setting its value to the desired version number (or change hardcoded defaultVersion in a build.gradle) .

Export all variables listed in Travis configuration section except DOCKERHUB_USERNAME, DOCKERHUB_PASSWORD.

For the variable ORG_GRADLE_PROJECT_signingKey use actual multiline key body (depending on your environment, setting up multiline variables could be challenging or not) .

Following bash expression could be used to set up multiline variable in bash:

export  ORG_GRADLE_PROJECT_signingKey=<EXACT CONTENT OF /tmp/travis_compatible_env_value.txt>

Also, every variable which name starts with ORG_GRADLE_PROJECT_<varname> could be instead configured as gradle setting <varname> (prefix stripped)

If you omit ossrhUsername setting, publishing would be done locally into directory buid/repo

If you omit sighingKey setting, signatures won’t be generated

Artifacts

The default artifact name base (appmap-agent) could be changed via variable ORG_GRADLE_PROJECT_publishArtifactId

Publishing

semantic-release invoked by Travis on master branch, triggers publishing task as a hook defined in .releaserc.yml

Since April 2021 we're using Gradle Nexus Publish plugin, old ./gradlew publish command is deprecated and likely won't work in "local filesystem" mode any more (not tested and not needed).

Nexus Publishing plugin takes care not only of uploading artifacts (like previously used maven-publish plugin does) but also automates the procedures of "closing" and "releasing" repository in OSSRH

Manual invocation of publication task:

./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository (triggered by semantic-release, most complete flow)

or

./gradlew publishToSonatype closeReleaseSonatypeStagingRepository (more conservative, skips the step of pushing to Maven Central)

Backlog

  • BUG? Javadoc is intentionally empty due to errors in javadoc generation.