Skip to content

Release

Jump to bottom
bparmar-splunk edited this page Dec 10, 2021 · 72 revisions

Splunk SDK for Java Release Instructions

These are instructions on the various steps necessary to cut out a new release of the Splunk SDK for Java. Even though the instructions are public, these steps are only meant to be taken by the SDK maintainers.

Prerequisites

  • Read through all of these release instructions.
    • Update the version numbers in this document to the version you're about to release.
    • Update any steps if necessary.
    • For updates that could apply to other SDKs as well, update the release instructions page for every other SDK.
  • Update changelog.

Release Steps

  • Create release branch off of develop (release/1.8.0).

    • git checkout develop
    • git pull
    • git checkout -b release/1.8.0

  • Update the version number:

    • Update the version property in the all pom.xml file in the root directory.
    • Update the User-Agent field of the HttpService class.
    • Update README.md.
    • Update the line declare -r version="??" in deploy.
    • Update the version everywhere in deploy.md.

  • Make sure the version number change didn't break anything:

    • Push the release/1.8.0 branch.
    • Wait for Github Actions to run tests against the release/1.8.0 branch.

  • Send PR from release/1.8.0 to master; after approval then merge PR

  • Sanity check that the released version works (clone SDK afresh, build).

    • git clone git@github.com:splunk/splunk-sdk-java.git
    • cd splunk-sdk-java
    • git checkout master
    • mvn package

  • Start release using github releases-> draft a new release

  • Build a new JAR and ZIP of the SDK:

    • Make sure the JAR is built with JDK 8.
    • Download the ZIP from the GitHub releases page.
    • Make sure the file names reflect the current version (for example, splunk-sdk-java-1.8.0.zip, splunk-1.8.0.jar).

  • Deploy to ArtifactoryOnline

  • Work with Docs team to:

    • Post ZIP (download from github release page) and JAR (need to build on your local machine generated at /dist folder) files.
    • Create both MD5 and SHA-512 hashes from final ZIP download. Docs will contact the Web team to upload these files.
    • Update Readme. For point releases, the version number needs to be updated at a minimum.
    • Update Dev Portal and push. For point releases, the "What's new" page and download links need to be updated at the very least.
    • Publish the API Reference (docs.splunk.com/Documentation/SDK).

  • Verify the posted JAR:

    • Download the JAR and make sure the checksum matches the original file.

  • Hand off to marketing to announce. See next section.

Announce!

Hurrah, the new release is basically done! You can now announce it on the following channels:

Clone this wiki locally