Add documentation about releasing

medic · Jun 14, 2018 · bd95ea9 · bd95ea9
1 parent 2573988
commit bd95ea9
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog
 
+## v1.16.18
+* Add documentation about releasing
+
 ## v1.16.17
 * [jshint] don't let config changes leak
 

diff --git a/README.md b/README.md
@@ -263,3 +263,11 @@ To compress PNGs and SVGs in the current directory and its subdirectories, two c
 ## Wishlist
 
 * only upload things which have changed (this could be a separate mode - e.g. `update` vs `configure`)
+
+# Releasing
+
+1. bump version number in `package.json`
+2. `npm install` to update `package-lock.json`
+3. `npm run generate-changelog` to update `CHANGELOG.md`
+4. `npm run release`
+5. try to work out how you can commit the CHANGELOG including the change that includes the CHANGELOG update before you run the release script
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "medic-conf",
-  "version": "1.16.17",
+  "version": "1.16.18",
   "description": "Configure Medic Mobile deployments",
   "main": "index.js",
   "scripts": {