Release

Splunk SDK for C# PCL Release Instructions

These are instructions on the various steps necessary to cut out a new release of the Splunk SDK for C# PCL. 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 if necessary. (For example, the version numbers will need updating.)
  • For updates that could apply to other SDKs as well, update the release instructions page for every other SDK.
• Update changelog.
• Run test suite on full test matrix.
• Run all examples.
• Run all dev.splunk.com code samples.
• Remove old temporary branches. This includes feature branches, old release branches, and most branches that have been merged to develop.

Release Steps

• Read through all of these release instructions, and update them if necessary. The version numbers at least will often need updating.
• Remove old temporary branches. This includes feature branches, old release branches, and most branches that have been merged to develop.
• Optional: Create a release branch off of develop. This avoids problems if anyone else is merging code into develop while you are trying to release.
  • If using this strategy, follow the branching steps from the other Splunk SDKs.
• Update the CHANGELOG.
• Update the version number wherever it appears in the SDK. The known places are:
  • README.md
  • CHANGELOG.md
  • Properties->Assembly Information for all projects under '1. src'
  • Rebuild the solution to make the version number changes in code
• Run the test suite on the full test matrix.
• Run all the examples.
• Merge develop to master
  • git checkout master
  • git merge --no-ff -m "Release 2.1.2" develop
  • git commit
• Tag the commit as 2.1.2
  • git tag 2.1.2
• Push everything to GitHub
  • git push origin master
  • git push --tags
• Delete any temporary branches
  • Make sure to keep master and develop
• Tell MyGet to rebuild the package, credentials are available on the internal Confluence
• Push from MyGet to NuGet
• Create a zip file and MD5 and SHA-512 hashes for the docs team
  • curl 'https://codeload.github.com/splunk/splunk-sdk-csharp-pcl/zip/master' > splunk_sdk_csharp_pcl-2.1.2.zip
  • md5 splunk_sdk_csharp_pcl-2.1.2-beta.zip > splunk_sdk_csharp_pcl-2.1.2.zip.md5
  • shasum -a 512 splunk_sdk_csharp_pcl-2.1.2-beta.zip > splunk_sdk_csharp_pcl-2.1.2.zip.sha512
  • Email the three files to the docs team to stage for posting to the website