Skip to content

Release steps

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

Splunk Logging for Javascript Release Instructions

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

Prerequisites

  • Read through all of these release instructions.
  • Verify tests are passing in CI on full test matrix.
  • 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

  • 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.)
    • Update all other references to the most recent version (except previous CHANGELOG) including: readme, examples, tests, package.json, splunklogger.js to version X.Y.Z
  • Make sure the docs compile properly (and that they contain everything you want)
    • npm run docs
    • View local generated docs/ directory in the browser
  • Put up a PR to merge the Release branch to master
    • When PR merges, make sure the release branch is deleted
  • After merging, put up a Master -> Develop PR and merge so that changes are reflected in develop branch
  • Upload the SDK to NPM repository:
    • This is now done as part of Github Actions automation
  • Create a new release and tag
    • This is now done as part of Github Action automation
  • Update release on Github with details from CHANGELOG for the version just released
  • Sanity check that released version works:
    • Run examples locally using published version from npm
  • Create a ZIP of the SDK and send it to your Docs team:
    • Make sure the file reflects the current version (for example, splunk-javascript-logging-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.

Announce!

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

Clone this wiki locally