Merge branch 'develop' into 60-tests

Author: quinn-dougherty

.github/workflows/gh-pages.yml

@@ -3,7 +3,7 @@ name: Publish GitBook to GH Pages
 on:
   push:
     branches:
-      - 'releases/v1'
+      - 'develop'
 
 
 jobs:
@@ -25,6 +25,6 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         HAB_LICENSE: accept
       with:
-        ref: master
+        ref: develop
         holobranch: gh-pages
         commit-to: gh-pages

docs/CONTRIBUTING.md

@@ -12,10 +12,10 @@ We maintain a list of [issues in the Code for Philly repo](https://github.com/co
 
 ## Change Management
 
-- Base all work on the latest `master` branch available in [Code for Philly's fork of the `chime` repository](https://github.com/CodeForPhilly/chime).
+- Base all work on the latest `develop` branch available in [Code for Philly's fork of the `chime` repository](https://github.com/CodeForPhilly/chime).
 - Submit your work in the form of a pull request against that same branch.
 - Check in on your pull request periodically after you submit it to see if any changes have been requested or any merge conflicts have arisen from other work getting integrated.
-- If a merge conflict arises, please rebase your branch against the latest `master` branch and force-push the new branch as early as you can. You may need to do this more than once before your changes get merged. Do your best to keep your branch in a mergeable state until it is finished being reviewed and accepted.
+- If a merge conflict arises, please rebase your branch against the latest `develop` branch and force-push the new branch as early as you can. You may need to do this more than once before your changes get merged. Do your best to keep your branch in a mergeable state until it is finished being reviewed and accepted.
 
 ## Requesting Functionality
 

docs/README.md

@@ -2,6 +2,6 @@
 
 This book is the living documentation for developers and operators working on [the CHIME project](https://github.com/CodeForPhilly/chime) or running instances of it.
 
-It is maintained in the [GitBook format](https://gitbookio.gitbooks.io/docs-toolchain/structure.html) within [the `docs/` directory](https://github.com/CodeForPhilly/chime/tree/master/docs) of the project's main Git repository, and new versions are published automatically upon merge to the `master` branch to: [codeforphilly.github.io/chime](https://codeforphilly.github.io/chime)
+It is maintained in the [GitBook format](https://gitbookio.gitbooks.io/docs-toolchain/structure.html) within [the `docs/` directory](https://github.com/CodeForPhilly/chime/tree/develop/docs) of the project's main Git repository, and new versions are published automatically upon merge to the `develop` branch to: [codeforphilly.github.io/chime](https://codeforphilly.github.io/chime)
 
-To contribute to this book, please [open a pull request against the master branch of github.com/CodeForPhilly/chime](https://github.com/CodeForPhilly/chime/compare/master).
+To contribute to this book, please [open a pull request against the develop branch of github.com/CodeForPhilly/chime](https://github.com/CodeForPhilly/chime/compare/develop).

docs/SUMMARY.md

@@ -9,6 +9,7 @@
   - [Data Analysis](contributing/data-analysis.md)
   - [Operations Support](contributing/operations-support.md)
 - Operations
+  - [Release Process](./operations/release-process.md)
   - [The `chime-live` Cluster](./operations/chime-live-cluster.md)
   - [Deploy to Heroku](./operations/heroku.md)
   - [Deploy to Your Own Cluster](./operations/byok8s.md)

docs/operations/chime-live-cluster.md

@@ -32,18 +32,17 @@
 
 ## Deploying a New CHIME Version
 
-1. Merge new version into `master` branch
-2. Create a new release tag in the format `v1.2.3`, incrementing semantically
-3. Wait for the `Docker` GitHub Actions workflow to complete
-4. Verify the new version shows up at the top as "Latest version" here: https://github.com/CodeForPhilly/chime/packages/155340
-5. Run:
+1. [MaCreateke a new release](release-process.md)
+2. Wait for the `Docker` GitHub Actions workflow to complete
+3. Verify the new version shows up at the top as "Latest version" here: https://github.com/CodeForPhilly/chime/packages/155340
+4. Run:
 
     ```bash
     VERSION=1.2.3
     kubectl set image --record deployment/chime chime="docker.pkg.github.com/codeforphilly/chime/penn-chime:${VERSION}"
     ```
 
-6. Watch rollout status:
+5. Watch rollout status:
 
     ```bash
     kubectl rollout status deployment.v1.apps/chime
@@ -68,5 +67,5 @@ kubectl apply -f k8s/infra/ingress-nginx.yaml
 Or the entire directory:
 
 ```bash
-kubectl diff -Rf k8s/
+kubectl apply -Rf k8s/
 ```

docs/operations/release-process.md

@@ -0,0 +1,25 @@
+# Operations: Release Process
+
+1. Merge pull requests into `develop`
+2. Chose a new version number by incrementing the previous release according to [semver](https://semver.org/)
+   - Do not bump the MAJOR version unless the team is ready to create a new `releases/v#` branch
+3. Open a pull request to merge `develop` into `releases/v1`
+   - **Title**: `Release: CHIME v1.#.#`
+   - **Description**: Generate with this command:
+
+        ```bash
+        git fetch origin
+        git log \
+            --first-parent \
+            --reverse \
+            --pretty=format:"- %s" \
+            "origin/releases/v1..origin/develop"
+        ```
+
+4. Get release pull request approved by [`@cjbayesian`](https://github.com/cjbayesian) or [`@mdbecker`](https://github.com/mdbecker)
+5. Merge the pull request
+6. [Create a new release against `releases/v1`](https://github.com/CodeForPhilly/chime/releases/new?target=releases/v1)
+   - **Tag version:** `v1.#.#`
+   - **Release Title:** `CHIME v1.#.#`
+   - **Description:** Copy release notes from pull request
+7. [Deploy to the `chime-live` cluster](chime-live-cluster.md)