Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.25 KB

RELEASING.md

File metadata and controls

69 lines (46 loc) · 2.25 KB

Release Process

Bump dependencies

To bump all (execpt the /build module's) dependencies run:

./goyek.sh bump mod

Pre-Release

  1. Verify if wizard and official docs needs any adjustments. Create a Pull Request with documentation updates in splunk/public-o11y-docs if necessary. Contact @splunk/gdi-docs team if needed.

  2. Create a new release branch. I.e. git checkout -b release-X.X.X main.

  3. Update the version in versions.yaml

  4. Run the pre-release step which updates go.mod and version.go files in modules for the new release.

    ./goyek.sh prerelease
  5. Merge the branch created by multimod into your release branch.

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

  7. Push the changes 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 for the the commit of the merged Pull Request.

    ./goyek.sh -commit <commit> -remote <remote> release

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.

Post-Release

Bump versions in the following examples: