Skip to content

Creating releases

Jump to bottom
Chris Lasher edited this page Aug 28, 2020 · 6 revisions

Preparation

  • Ensure the CHANGELOG.md has all updates since the previous release. Follow the recommendations from https://keepachangelog.com/
  • Ensure the version in getignore.go has been updated to reflect the version to be released.

Tagging

Tag the appropriate commit with

git tag -a -m "Release <major>.<minor>.<patch>" v<major>.<minor>.<patch>

and push with

git push --follow-tags

Create the distribution artifacts.

Run

make dist

This will cross-compile multiple versions of the getignore executable for different OS and architecture combinations using gox. View the Makefile to see what OS-architecture combinations will be produced.

It will also prepare archival versions of these artifacts (e.g., .tar.gz and .zip) with accommodating files. These are the distribution artifacts you need to upload to the GitHub Release.

You will find the artifacts in the dist/ subdirectory.

Create a GitHub Release

Make a new GitHub Release. Name the release after the version, "..".

Add highlights of what has changed in the new release since the last; you can borrow from the Changelog.

Upload the appropriate distribution artifacts created in the step above.

Update the package repositories

Update the package repositories to point to the latest version and appropriate artifacts:

Clone this wiki locally