diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a0e6a4ef..9bb80cf68 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,3 +37,27 @@ If you have to add another go dependency, you can follow the steps: We use vendoring, so the last step is required. +## Releasing a new version + +> This is only possible if you're a repository maintainer. + +The release is driven by a Github **workflow** triggered when a new **tag** is **created**. The workflow will run the checks and trigger _Goreleaser_ to: +- create the Release with the proper description (changelog) +- upload the binaries for the different architectures +- update https://github.com/auth0/homebrew-auth0-cli with the latest binary reference + +To release a new version: + +1. pull the latest changes: + - `$ git checkout main` + - `$ git pull origin main` +2. check the latest tag: + - `$ git fetch` + - `$ git tags` +3. create the **new** tag for the new release. For example, if the latest tag is `v0.1.1` and you want to release a patch version, you should create `v0.1.2`: + - `$ git tag v0.1.2` +4. push the new tag: + - `$ git push origin v0.1.2` + +The rest of the process will take place in the github action: https://github.com/auth0/auth0-cli/actions/workflows/goreleaser.yml. +Once the workflow finishes, a new release will be available for the newly created tag.