Skip to content

RELEASE.md

Latest commit

 

History

History
75 lines (53 loc) · 2.39 KB

RELEASE.md

File metadata and controls

75 lines (53 loc) · 2.39 KB

Release

This document outlines the process for creating a new release for Directory using the Go MultiMod Releaser. All code block examples provided below correspond to an update to version v1.0.0, please update accordingly.

1. Update the New Release Version

  • Create a new branch for the release version update.
git checkout -b release/v1.0.0
  • Modify the versions.yaml file to update the version for Directory's module-set. Keep in mind that the same version is applied to all modules.
  directory:
-    version: v0.0.0
+    version: v1.0.0
  • Commit the changes with a suitable message.
git add versions.yaml
git commit -m "release: update module set to version v1.0.0"
  • Run the version verification command to check for any issues.

Note

If you use go.work and go.work.sum files in the project, temporarily remove/rename them so it won't interfere with this step.

task release:verify

2. Bump All Dependencies to the New Release Version

  • Run the following command to update all go.mod files to the new release version.
task release:prepare

Note

If this command fails with failed: working tree not clean, please run git stash --all and retry.

  • Review the changes made in the last commit to ensure correctness.

  • Push the branch to the GitHub repository.

git push origin release/v1.0.0
  • Create a pull request for these changes with a title like "release: prepare version v1.0.0".

3. Create and Push Tags

  • After the pull request is approved and merged, update your local main branch.
git checkout main
git pull origin main
  • To trigger the release workflow, create and push to the repository a release tag for the last commit.
git tag -a v1.0.0
git push origin v1.0.0

Please note that the release tag is not necessarily associated with the "release: prepare version v1.0.0" commit. For example, if any bug fixes were required after this commit, they can be merged and included in the release.

4. Publish release

  • Wait until the release workflow is completed successfully.

  • Navigate to the Releases page and verify the draft release description as well as the assets listed.

  • Once the draft release has been verified, click on Edit release and then on Publish Release.