Skip to content

Commit

Permalink
Update the release instructions (#1141)
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikSchierboom authored May 9, 2024
1 parent db9c0e8 commit be487d8
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,12 @@ The Exercism CLI uses [GoReleaser](https://goreleaser.com) to automate the relea
1. [Setup GitHub token](https://goreleaser.com/scm/github/)
1. Have a gpg key installed on your machine - it is [used for signing the artifacts](https://goreleaser.com/customization/sign/)

## Confirm / Update the Changelog

Make sure all the recent changes are reflected in the "next release" section of the CHANGELOG.md file.
All the changes in the "next release" section should be moved to a new section that describes the version number, and gives it a date.

You can view changes using the /compare/ view:
https://github.com/exercism/cli/compare/$PREVIOUS_RELEASE...main

## Bump the version

1. Create a branch for the new version
1. Edit the `Version` constant in `cmd/version.go`
1. Update the `CHANGELOG.md` file
1. Bump the `Version` constant in `cmd/version.go`
1. Update the `CHANGELOG.md` file to include a section for the new version and its changes.
Hint: you can view changes using the compare view: https://github.com/exercism/cli/compare/$PREVIOUS_RELEASE...main.
1. Commit the updated version
1. Create a PR

Expand Down

0 comments on commit be487d8

Please sign in to comment.