Release Process

The release process of this repository is straightforward 🙌🏽 . Almost every step has been automated 💯, releases must be triggered from the main branch, make sure that you are located in this branch and that the branch is up-to-date.

Release it!

Before triggering a release, ensure that your GITHUB_TOKEN env var is set. See GitHub docs for more info.

To trigger a new release, run the command:

$ make release

...

--> go-sdk: opening GH pull request
--> go-sdk:
--> go-sdk: It is time to review the release!
--> go-sdk:     "https://github.com/lacework/go-sdk/pull/367"

This make command automatically generates the release notes at RELEASE_NOTES.md,
it updates the CHANGELOG.md, updates the VERSION file to clear the -dev tag and opens a pull request to review.

This will allow team members to do any final review, wait for at least one approval,
then proceed to merge your PR! 🙌🏽 ✨

Success!

After merging your Pull Request, you are pretty much done! 🌟

📈 The pipeline will automatically handle the release.