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

• 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.

• Create release branch off of develop (release/0.1)
  • git checkout develop
  • git pull
  • git checkout -b release/0.1
• Update the version number:
  • Update the AssemblyVersion and AssemblyVersionproperty in Properties\AssemblyInfo.cs
  • Update README.md
• Make sure the version number change didn't break anything:
  • Install the SDK in a clean environment.
  • Run test suite.
  • Run the SDK examples.
• Merge to master locally. Ensure the commit message is "Release 0.1".
  • git checkout master
  • git merge --no-ff -m "Release 0.1" release/0.1
  • git commit
• Tag the above commit as 0.8.
  • git tag 0.8
• Push the master and the 0.8 tag to GitHub.
  • git push origin master
  • git push --tags
• Delete the release branch:
  • git push origin :release/0.8
  • git branch -d release/0.8
• Sign the assembly for Strong Name
  • Refer to C# ERD on how to do this.
• Build and package the assembly, PDB, and sources
  • Ensure Release configuration is selected in solution property page and binaries are from the Release folder. Also ensure that the assembly is strong name signed.
  • Publish NuGet package. Refer to C# ERD on how to do this.
  • Update zip file for Splunk.com download link
• Sanity check that released version works:
  • Run the search_oneshot example. This will cover the authentication part as well.
• Work with Docs team to:
  • 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. For point releases, the "What's new" page needs to be updated at a minimum.
  • Update API Reference docs (docs.splunk.com/Documentation/SDK)
  • 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.

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

• Twitter (@splunkdev, maybe @splunk)
• Google Groups (splunkdev)
• Dev Portal (http://dev.splunk.com)
• Dev Blog (http://blogs.splunk.com/dev)