From 7592e50ea4689b1a058a861e595e198cefa4eea5 Mon Sep 17 00:00:00 2001 From: ssube Date: Tue, 17 Sep 2019 19:40:44 -0500 Subject: [PATCH] fix(docs): note release process --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1d94d42..8d636e3 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,9 @@ This project contains the base configuration and build scripts for most of my Ty - [Features](#features) - [Intentionally Omitted Features](#intentionally-omitted-features) - [Usage](#usage) - - [Setup](#setup) - - [Daily](#daily) + - [To Setup](#to-setup) + - [To Build](#to-build) + - [To Release](#to-release) - [External Services](#external-services) - [Maintenance Bots](#maintenance-bots) - [External Secrets](#external-secrets) @@ -48,7 +49,7 @@ This project contains the base configuration and build scripts for most of my Ty ## Usage -### Setup +### To Setup To create a new repository from this template: @@ -63,7 +64,7 @@ To create a new repository from this template: - install your dependencies - write some code -### Daily +### To Build Once your project is set up: @@ -73,6 +74,16 @@ Once your project is set up: The `git-push` target pushed to Github first, to avoid conflicts with changes from bots and other contributors. +### To Release + +When your project is ready to release: + +- `make release-dry` to make sure your changelog and options look right +- `make release` + +Additional options can be passed with the `RELEASE_OPTS` variable. Frequently-used options include `--release-as minor` +and `--prerelease`. + ## External Services This template works with or expects a few external services, namely a Gitlab CI server (self-hosted or using