Merge pull request #234 from cmu-delphi/sgratzl/release-it

add release-it utility

Author: sgratzl

.gitignore

@@ -11,3 +11,5 @@
 /assets/jsconfig.json
 /static/uikit/**
 .DS_Store
+*.zip
+*.tgz

.release-it.json

@@ -0,0 +1,17 @@
+{
+  "hooks": {
+    "before:init": "npm run lint",
+    "before:release": "npm run build && npm run zip",
+    "after:release": "echo Successfully released ${name} v${version}."
+  },
+  "git": {
+    "tagName": "v${version}"
+  },
+  "npm": {
+    "publish": false
+  },
+  "github": {
+    "release": true,
+    "assets": ["website.zip"]
+  }
+}

README.md

@@ -103,3 +103,16 @@ In case you use new dependencies don't forget to either edit `environment.yml` o
 A Github action should runs when Rmd files changes so it will verify that the blog post can be built.
 However, the converted HTML file along with all generated images are committed to the repository.
 This simplifies the deployment and ensures that we have a blog post even when the API or data changes.
+
+
+### Release Process
+
+The release process is based on [release-it](https://github.com/release-it/release-it). To create a release, run
+
+1. create/checkout the release branch `release` and push to origin
+1. run `npm run release` and publish the release
+1. create a PR that merges the `release` branch in the `main` branch
+1. create a PR that merges the `main` branch back into the `dev` branch
+
+Then go to the release page and update short description of the changes made.
+