Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.97 KB

RELEASE.md

File metadata and controls

46 lines (33 loc) · 1.97 KB

Release proccess

The releases are triggered by creating a new tag on main. TravisCI will noticed the tag and will proceed to run the job. On a successful build the job will run GoReleaser. This will publish the build artifacts, push the docker image, and to upload the Kubernetes manifest template to download.newrelic.com. The build will also fill in the changelog with commits that aren't filtered by the GoReleaser config found here. To documentation to change what appears in the changelog can be found here.

To create a new release you need to tag the main branch with the new release version.

Version naming scheme

All release follow the semantic versioning scheme.

For the release in this project we tag main with the release version, with a prefix v before the version number. E.g. so release 1.2.3 would mean you tag main with the tag v1.2.3

Tagging via the command line

To tag via the cli you need to have Git installed. From a terminal run the command:

$ git tag -a vX.Y.Z -m 'New release with cool feature'

To kick off the release you then need to push the tag to github. This is done by running the following command:

$ git push origin vX.Y.Z

Once the this is done it then triggers a release on TravisCI. You can see the progress of the deployment here.

Tagging on Github

  1. Click on Releases.
  2. Click Draft a new release.
  3. Type a version number (with the prefix v), e.g. vX.Y.Z
  4. Set the release title, e.g. 'New release with cool feature'
  5. Then hit Publish release

Once the this is done it then triggers a release on TravisCI. You can see the progress of the deployment here.