Skip to content
This repository has been archived by the owner on Apr 21, 2023. It is now read-only.

Latest commit

 

History

History
54 lines (38 loc) · 1.18 KB

RELEASE.md

File metadata and controls

54 lines (38 loc) · 1.18 KB
Raw

Release procedure

This document describes how to release a new version of coil.

Versioning

Follow semantic versioning 2.0.0 to choose the new version number.

Prepare change log entries

Add notable changes since the last release to CHANGELOG.md. It should look like:

(snip)
## [Unreleased]

### Added
- Implement ... (#35)

### Changed
- Fix a bug in ... (#33)

### Removed
- Deprecated `-option` is removed ... (#39)

(snip)

Bump version

  1. Determine a new version number. Let it write $VERSION.

  2. Checkout master branch.

  3. Edit CHANGELOG.md for the new version (example).

  4. Commit the change and add a git tag, then push them.

    $ git commit -a -m "Bump version to $VERSION"
$ git tag v$VERSION
$ git push origin master --tags

Publish GitHub release page

Go to https://github.com/cybozu-go/coil/releases and edit the tag. Finally, press Publish release button.