Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 4.46 KB

RELEASING.md

File metadata and controls

90 lines (60 loc) · 4.46 KB
Raw

Releasing Guide for Kroxylicious Junit5 Extension

This document describes how to release this component.

The component is released using GitHub automation.

At a high level, the process is as follows:

  1. The developer adds their private key/passphrase as repository secrets
  2. The workflow stage_release tags, builds/signs the release, and stages the release on a Nexus staging repository. This process uses the GitHub machine account kroxylicious-robot and a user token owned by Sonatype account kroxylicious account.
  3. The stage release is verified using manual verification steps.
  4. The workflow deploy_release releases from the staged repository to Maven Central.
  5. The developer removes their private key/passphrase as repository secrets.

Pre-Requisites

You must be a member of the Kroxylicious organization and have access to create secrets within the kroxylicious-junit5-extension repository.

Create the following repository secrets:

Secret Description
KROXYLICIOUS_RELEASE_PRIVATE_KEY Private key of the project admin conducting the release
KROXYLICIOUS_RELEASE_PRIVATE_KEY_PASSPHRASE Passphrase used to protect the private key

Release steps

Use the Kroxylicious Team Developers Slack Channel to coordinate the release with the other developers. It is important no other work is merged to main during the release.

Stage the Release

Run stage_workflow. Set the release-version argument to the version being release e.g. 0.7.0.

This will:

  • raise single PR that will contain two commits:
    1. the first will version the artefacts at release-version. A release-version tag will point at this commit.
    2. the second will re-open main for development, at the next snapshot.
  • stage a release Nexus UI. It'll be named iokroxylioustesting-nn.

Verify the Release

You can validate the staged artefacts by having a test application (we'll call it T) that uses kroxylicious-junit5-extension use the Maven artefacts by making temporary (local) changes to its POM.

  1. Find the staging repository in the Nexus UI. It'll be named iokroxylioustesting-nn.
  2. Add a <repositories> that references the staging repository public url to T's POM.
  3. Update T's kroxylicious-junit5-extension dependency to refer to the <RELEASE_VERSION>.
  4. Run T build/test cycle but use an alternative cache location to be sure artefacts are being fetched. Check the build output, you'll see the kroxylicious-junit5-extension come from the staging location.
MAVEN_OPTS="-Dmaven.repo.local=/tmp/repository" mvn verify

If the build passes, proceed to make the release public. The local changes made to T's POM can be reverted.

Making the release public

  1. Run deploy_workflow setting the next-state to release to publish the artefact.
  2. Merge release PR (use Rebase and Merge strategy).
  3. Manually create the release notes for release by following the Draft a new release workflow. Copy the release note content from the CHANGELOG.md.
  4. Let Kroxylicious Team Developers know the release is finished.

If anything goes wrong, follow the steps in the next section.

Failed Releases

If the release fails verification, use the deploy_workflow to drop the snapshot repository and close the PR.

The release tag needs to be removed manually:

git push --delete origin v0.7.0

Remove your private key/passphrase

Remove your private key/passphrase secrets from the repository secrets.