Release Process

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

Release it!

To trigger a new release, run the command:

$ make release

...

remote: Resolving deltas: 100% (3/3), completed with 3 local objects.
remote:
remote: Create a pull request for 'release' on GitHub by visiting:
remote:      https://github.com/lacework/go-sdk/pull/new/release
remote:
To github.com:lacework/go-sdk.git
 * [new branch]      release -> release
--> go-sdk:
--> go-sdk: Follow the above url and open a pull request

This make command automatically generates the release notes at RELEASE_NOTES.md,
updates the CHANGELOG.md and updates the VERSION file to have the -release tag.

This step requires human intervention to update and add relevant documentation to
the release notes, look at previous releases for guidance:

• https://github.com/lacework/go-sdk/releases 💯 ⭐ 📝

Once you've finished updating and polishing the release notes and changelog, open a
Pull Request (PR) by following the URL:

• https://github.com/lacework/go-sdk/pull/new/release

Use the content of the RELEASE_NOTES.md as the description of the PR. Here is an
example of how the PR should look like: https://github.com/lacework/go-sdk/pull/116

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.