Skip to content

Release Checklist

Jump to bottom
Rich Vanderwal edited this page Mar 20, 2021 · 35 revisions

Release Checklist

Checklist Steps

  1. Is the agent ready for release?

  2. Create, review, and merge a branch into the develop branch with these version changes:

    • Change the version in version.go
    • Add a new section header to the top of CHANGELOG.md
    • Go over the release notes with the PM

  3. Open a pull request from the develop branch into master

    • Ensure that the tests all pass
    • Merge the PR into master

  4. Once the version change has been merged, tag the commit with the prefix "v"

    • Example: git tag v1.0.0 9191db2
    • If a new integration package was release or if one was updated, tag it as well: git tag v3/integrations/nrelasticsearch-v7/v1.0.0
      • You can check which integrations need to be released with a git command like this: git diff --name-only v3.1.0... | grep -v test

  5. Push the release tag

    • Example: git push --tags

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

    • If you find broken links, DO NOT just update the links & change commit that the release tag points to - this will break the checksum for the release. Instead, you will need to do a new release with the fixes.

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

  8. Add the release notes to the New Relic documentation site:

    • find or check out the docs-website repository.
    • copy the previous version's release notes file to a new file. You'll see the files in /src/content/docs/release-notes/agent-release-notes/go-release-notes/. Name it appropriately. For example, to release the v3.11.0 agent, we copied the go-agent-3100.mdx file to a new go-agent-3110.mdx file.
    • edit the new file, changing the version number in the metadata at the top, and replacing the content below with the new Release Notes markdown text.
    • Commit changes to a new branch and make a PR:
      • git co -b go-agent-release-v<version_number>
      • git add <the_new_file>
      • git commit -m "Release notes for Go Agent v<version_number>"
      • git push <your remote> go-agent-release-v<version_number>
      • Open up a new PR using the browser link that git provides. Follow the instructions given to you in the Documentation team's PR template.
    • NOTE! Github relative links won't work on the docs site, so check the links!

  9. Send an email to [email protected] with the release notes and the release number.

    • NOTE! Github relative links won't work on in the email!

  10. Close all public PRs that have just been released!

  11. Are there new docs staged? (use the content search for look Hold for Release documents) If so tell the #documentation @hero to release the docs!

  12. Update Angler to include the new supportability metric for the newly released version of the agent.

  13. Update RPM agent versions:

  14. Announce the release in #go-agent slack room to accrue all the emojis.

  15. 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 Managers does this too -- they may have work to do regarding this as well.

  16. Monitor use of the new agent using the Go Agent Angler dashboard.

Clone this wiki locally