Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 2.41 KB

RELEASING.md

File metadata and controls

71 lines (48 loc) · 2.41 KB
Raw

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. Verify the changes.

    git diff main

    This should have changed the version for all modules to be <new tag>.

  3. Update the Changelog.

    • Make sure all relevant changes for this release are included and are in language that non-contributors to the project can understand. To verify this, you can look directly at the commits since the <last tag>.

      git --no-pager log --pretty=oneline "<last tag>..HEAD"

    • Move all the Unreleased changes into a new section following the title scheme ([<new tag>] - <date of release>).

    • Update all the appropriate links at the bottom.

  4. Push the changes to upstream and create a Merge Request. Be sure to include the curated changes from the Changelog in the description.

Tag

Once the Merge 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.

  1. Run the tag.sh script using the <commit-hash> of the commit on the main branch for the merged Pull Request.

    ./tag.sh <new tag> <commit-hash>

  2. Push tags to the origin remote (github.com/gojekfarm/xtools.git). Make sure you push all sub-modules as well.

    git push origin <new tag>
git push origin <submodules-path/new tag>
...

    Use this to push all tags at once.

    IMPORTANT: Use this with care, you may end up pushing unintended tags.

    git push --tags

Release

Finally create a Release for the new <new tag> on Gitlab. The release body should include all the release notes from the Changelog for this release. Additionally, the tag.sh script generates commit logs since last release which can be used to supplement the release notes.