Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.25 KB

RELEASE.md

File metadata and controls

63 lines (39 loc) · 1.25 KB
Raw

Release

When you are ready to release a new version, follow these steps:

  1. Bump up the VERSION

  2. Update CHANGELOG.md

  • Replace the [Unreleased] with the version number.
  • Add current date to version number line.
  • Add a new [Unreleased] version.
  • Add a git diff link to the end of the file, and update the unreleased diff link.

  1. Commit the changes

  2. Add a new tag

git tag -a v1.2.3 -m v1.2.3
  1. Update latest tag
git push origin :refs/tags/latest
git tag -f -a latest -m latest
  1. Push the tag
git push --tags
  1. Go to Releases page in Github and draft a new release

Use the following content:

Tag version: <the newly created tag>

Release title: <version number>

Describe this release:

<copy the content from the [CHANGELOG.md](CHANGELOG.md)>

Here's a full example:

Tag version: v5.0.0

Release title: v5.0.0

Describe this release:

### Changed

- Upgraded Clojure from 1.8.0 to 1.9.0
  1. Announce the new version at the Open Source Community Forum