docs: releasing

Author: unicornware

.github/labels.yml

@@ -80,6 +80,10 @@
   description: No action to be taken or missing information
   color: e7034b
 
+- name: status:merged
+  description: Merged into next, but not into main (or released)
+  color: e7034b
+
 - name: status:needs-triage
   description: Needs verification and minimal reproduction
   color: e7034b

.github/workflows/continous-deployment.yml

@@ -0,0 +1,49 @@
+# Continuous Deployment
+#
+# References:
+#
+# - https://docs.github.com/en/actions/guides/building-and-testing-nodejs
+# - https://jestjs.io/docs/cli#--ci
+
+---
+name: Continuous Deployment
+on:
+  release:
+    types: [published]
+jobs:
+  continuous-deployment:
+    runs-on: ubuntu-latest
+    env:
+      PAT_GPR: ${{ secrets.PAT_GPR }}
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v2
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v2
+        with:
+          always-auth: true
+          cache: 'yarn'
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@flex-development'
+      - name: Install dependencies
+        run: yarn
+        env:
+          NODE_AUTH_TOKEN: ${PAT_GPR}
+      - name: Run test suites
+        run: TERM=xterm-256color yarn test --ci
+      - name: Setup .npmrc file [GPR]
+        uses: actions/setup-node@v2
+        with:
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@flex-development'
+      - name: Get release version
+        uses: actions/github-script@v4
+        id: v
+        with:
+          script: |
+            core.setOutput('v', github.event.release.tag_name.split('@')[1])
+      - name: Publish @flex-development/${{ github.event.release.tag_name }}
+        if: ${{ startsWith(github.event.release.tag_name, 'grease@') }}
+        run: npm publish packages/grease/build --tag ${{ steps.v.outputs.v }}
+        env:
+          NODE_AUTH_TOKEN: ${PAT_GPR}

.versionrc.js

@@ -6,7 +6,7 @@
 module.exports = {
   commitAll: true,
   gitdir: process.env.PROJECT_CWD,
-  releaseBranchWhitelist: ['main'],
+  releaseBranchWhitelist: ['release/*'],
   skipUnstable: false,
   types: [
     { type: 'feat', section: ':sparkles: Features' },

CONTRIBUTING.md

@@ -349,7 +349,34 @@ e.g: `merge: P010-1 (#1)`
 
 ## Releasing
 
-**TODO**: Update documentation.
+This repository is configured to release a new version for a workspace when a
+Github Release is published. Any member with push access can create a release.
+
+> Note: Publishing is executed via the
+> [Continuous Deployment](./.github/workflows/continous-deployment.yml)
+> workflow. This is so invalid or malicious versions cannot be released by any
+> maintainer without merging those changes into `main` first.
+
+Before cutting a new release, the following steps must be completed:
+
+- create a new `release/*` branch
+  - where `*` is `<package.json#name-no-scope>@<version>`. e.g: `[email protected]`
+- decide what version bump this release needs (major, minor, patch)
+  - versioning
+    - `yarn release:node` (determines [bumps based on commits][17])
+    - `yarn release:node --release-as major`
+    - `yarn release:node --release-as minor`
+    - `yarn release:node --release-as patch`
+  - a new release will be drafted
+- a new pull request is opened from `next` into `main`
+  - the PR should be titled `release: <tag-prefix>@<x>.<x>.<x>`
+  - after review, **create a merge commit**: `release: <tag-prefix>@<x>.<x>.<x>`
+- after the PR is merged, a maintainer will publish the drafted released to
+  trigger the Continuous Deployment workflow
+- the maintainer who merged the release PR should wait and see if the workflow
+  successfully publishes the workspace project(s) to the GitHub Package Registry
+- all issues labelled `status:merged` released under `<tag-prefix>@<x>.<x>.<x>`
+  should be closed and have the label `status:released` added
 
 [1]: https://www.atlassian.com/software/jira
 [2]: https://yarnpkg.com/getting-started/migration
@@ -366,3 +393,6 @@ e.g: `merge: P010-1 (#1)`
 [13]: https://jestjs.io
 [14]: https://jestjs.io/docs/api#describeskipname-fn
 [15]: https://jestjs.io/docs/api#testskipname-fn
+[16]:
+  https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release
+[17]: https://www.conventionalcommits.org/en/v1.0.0