From e91344d404ceb0adf1e38172a8fe34d4d17eea80 Mon Sep 17 00:00:00 2001 From: Tom Limoncelli Date: Thu, 16 Feb 2017 15:41:59 -0500 Subject: [PATCH] Add a CHANGELOG.md --- CHANGELOG.md | 3 +++ RELEASE_ENGINEERING.md | 20 ++++++++++++++++++-- 2 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9610a6d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +Release v1.20170127 + +* Starting CHANGELOG. diff --git a/RELEASE_ENGINEERING.md b/RELEASE_ENGINEERING.md index 163ae04..6310d15 100644 --- a/RELEASE_ENGINEERING.md +++ b/RELEASE_ENGINEERING.md @@ -27,7 +27,23 @@ Stable Releases Marking the software to be "stable": -Step 1. Tag it. +Step 1. Update CHANGELOG.md + +Use "git log" to see what has changed and update CHANGELOG.md. + +For a new release, add: + +``` + echo Release v1.$(date +%Y%m%d) +``` + +Commit with: + +``` +git commit -m'Update CHANGELOG.md' CHANGELOG.md +``` + +Step 2. Tag it. ``` git pull @@ -37,7 +53,7 @@ git tag stable git push origin tag stable ``` -Step 2. Mark your calendar 1 week from today to check to see if this should be promoted to production. +Step 3. Mark your calendar 1 week from today to check to see if this should be promoted to production. Production Releases ===================