Skip to content

Release Checklist

Rich Vanderwal edited this page Apr 2, 2021 · 35 revisions

1. Track the release

Is there a release issue in GitHub Issues? If not, make one.

2. Pre-release Checks

3. Final Release PR

  • Changelog
    • Add a new section header to the top of CHANGELOG.md
    • Go over these release notes with your Product Manager and have them make changes/corrections to the PR.
  • Change the number in exporter.go:
    • Example version = "0.1.0"
  • Review and merge the PR into master

4. Link Check

  • Check all of the links in the changelog and godocs. While they should all have been tested if possible before, some links can't be tested until you have published to GitHub.

5. Tag

  • Tag that last commit with the prefix "v"
    • Example: git tag v1.0.0 9191db2
  • Push the release tag
    • Example: git push --tags

6. GitHub Release

  • Add the release notes to the GitHub release. Go to Releases > Draft a new release, put in the release notes, and mark it with the tag for the release.

7. Cleanup

  • Check to make sure any documentation changes associated with the PRs are released to the public.
  • Close all public PRs that have just been released.

8. Brag

  • Announce the release in #go-agent and @opentelemetry slack rooms to accrue all the emojis.
  • Communicate bug fixes and new features to the customers who have requested them. Go through support tickets, GitHub Issues, etc. and let people know to try the new agent to fix their troubles. Make sure your Product Manager does this too, they may have had requests you don't know about.

9. Monitor Use

  • TODO: figure out the best way to monitor usage.
Clone this wiki locally