Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.51 KB

RELEASING.md

File metadata and controls

49 lines (33 loc) · 1.51 KB

Release Process

Pre-Release

Update go.mod for submodules to depend on the new release which will happen in the next step.

  1. Run the pre-release script. It creates a branch pre_release_<new tag> that will contain all release changes.

    ./pre_release.sh -t <new tag>

  2. Update CHANGELOG.md with new the new release.

  3. Push the changes to upstream and create a Pull Request on GitHub.

Tag

Once the Pull Request with all the version changes has been approved and merged it is time to tag the merged commit.

IMPORTANT: It is critical you use the same tag that you used in the Pre-Release step! Failure to do so will leave things in a broken state.

IMPORTANT: There is currently no way to remove an incorrectly tagged version of a Go module. It is critical you make sure the version you push upstream is correct. Failure to do so will lead to minor emergencies and tough to work around.

  1. Run on the main branch and specify the commit for the merged Pull Request.

    make add-tag tag=<new tag> commit=<commit>

  2. Push tags to the upstream remote (not your fork): github.com/signalfx/splunk-otel-go.git.

    make push-tag tag=<new tag> remote=upstream

Release

Create a Release for the new <new tag> on GitHub. The release body should include all the release notes for this release taken from CHANGELOG.md.