Skip to content

Release

Jump to bottom
Tim Pavlik edited this page Jul 2, 2021 · 54 revisions

Splunk SDK for JavaScript Release Instructions

These are instructions on the various steps necessary to cut out a new release of the Splunk SDK for JavaScript. 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 changelog.
  • Regenerate compiled files for running tests and exmaples.
    • ./sdkdo compile (Use node 0.10.x)
  • Verify tests passing on full test matrix in CI.
  • Run all examples.
  • Remove old temporary branches. This includes feature branches, old release branches, and most branches that have been merged to develop.
    • Other branches that SHOULD NOT be deleted are: gh-pages (for Github pages).

Release Steps

In these instructions X.Y.Z refers to the new version to be released e.g. 1.2.3 In these instructions X.Y.Z refers to the new version to be released e.g. 1.2.3

  • Create release branch off of develop (release/X.Y.Z).
    • git checkout develop
    • git pull
    • git checkout -b release/X.Y.Z
  • Update the version number:
    • Set version key in package.json to X.Y.Z. (This needs to be a 3-component string.)
    • Set the version number at the top and in the installation instructions the README.md.
    • Set the SDK_UA_STRING variable in the github_commits example on line 29
  • Regenerate compiled files and check into repository.
    • ./sdkdo compile (Use node 0.10.x)
    • Commit changes.
  • Make sure the version number change didn't break anything:
    • Wait for CI to run and return all tests passing for full matrix
  • Make sure the docs compile properly (and that they contain everything you want)
    • ./sdkdo docs
  • Put up a PR to merge the Release branch to Master
    • Delete the release branch when merged
  • Upload the SDK to NPM repository:
    • This is now done as part of Github Actions automation
  • Create a new tag and release in Github:
    • This is now done as part of Github Actions automation
  • Sanity check that released version works:
    • Run examples locally.
  • Create a ZIP of the SDK and send it to your Docs team:
    • Make sure the file reflects the current version (for example, splunk-sdk-javascript-X.Y.Z.zip).
    • Download the ZIP from the GitHub releases page.
  • Work with Docs team to:
    • Post ZIP file.
    • Update Readme. For point releases, the version number needs to be updated at a minimum.
    • Update Changelog, includes a list of changes for the current version.
    • 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 API Reference.
    • Create both MD5 and SHA-512 hashes from final ZIP download. Docs will contact the Web team to upload these files.
  • Hand off to marketing to announce. See next section.
  • Make an internal pull request with the updated compiled splunk.js and splunk.min.js to core. (instructions needed)

Announce!

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

Clone this wiki locally