From dd2102d973065894f6db84c70fa807489992444e Mon Sep 17 00:00:00 2001 From: Leonora Tindall Date: Sun, 29 Dec 2019 12:47:18 -0800 Subject: [PATCH] Formalize release process --- CHANGELOG.md | 4 ++-- CONTRIBUTING.md | 10 ++++++++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 35f90bc..63015f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## Unreleased - 0.2.0 +## Unreleased - v0.2.0 ### Added @@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Security -## 0.1.0 +## v0.1.0 ### Added - GNU GPL v3 license diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f90d0f1..392420a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,3 +17,13 @@ CHANGELOG.md. All method documentation is written in the present tense. For example, "Creates a new..." rather than "Create a new...". + +## Cutting a Release + +When cutting a release: + +- In CHANGELOG, rename the Unreleased section and add a new Unreleased section above it +- Make a commit with only that change +- Tag that commit like "v1.0.0" +- Push main and the tag +- `cargo publish`