mirror of
https://github.com/stefan01/transocks.git
synced 2025-02-22 03:30:45 +07:00
1.2 KiB
1.2 KiB
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
-
Determine a new version number. Let it write
$VERSION
. -
Checkout
master
branch. -
Edit
CHANGELOG.md
for the new version (example). -
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.