@unimelb/pattern-lib-vue 11.1.2 → 11.2.3

package/README.md

@@ -50,21 +50,6 @@ Storybook is the main development environment.
 - `yarn dev` - [http://localhost:7002/](http://localhost:7002/)
 - `yarn build` to build the documentation site to `/.out/docs`. Environment variable `LOAD_EXTERNAL_ASSETS` controls whether the documentation site is to load the library assets locally (`false`) or from the CDN (`true`).
 
-### Commit message format
-
-- The project uses [Semantic Release](https://semantic-release.gitbook.io/semantic-release/) to automate the release process. And it uses the commit messages to determine the type of changes in the codebase. Following formalized conventions for commit messages, **semantic-release** automatically determines the next [semantic version](https://semver.org) number, generates a changelog and publishes the release.
-- By default **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format).
-
-The table below shows which commit message gets you which release type when `semantic-release` runs (using the default configuration):
-
-| Commit message                                                                                                                                                                                   | Release type               |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
-| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | Patch Release              |
-| `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | ~~Minor~~ Feature Release  |
-| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
-
-
-- Every commits that contains `[skip release]` or `[release skip]` in their message will be excluded from the commit analysis and won't participate in the release type determination.
 ### Generator
 
 This project includes generators to speed up common development tasks. Commands include:
@@ -150,21 +135,58 @@ For your own sanity, make sure to install your code editor's ESLint and stylelin
 - `yarn lint:js`
 - `yarn lint:js --fix`
 
+## Release process
+
+**At the start of a new release sprint:**
+
+- Create a milestone called `next-release`.
+
+**Throughout the release sprint:**
+
+- Assign the appropriate `pr-` label to every new PR: `pr-major` if it contains a breaking change, `pr-minor` if it adds a new feature, `pr-patch` in all other cases.
+- Assign issues and PRs to `next-release` as they are resolved/merged.
+- Assign additional labels to issues when relevant (e.g. `bug`, `chore`, `feature`, etc.)
+
+**At the end of the release sprint:**
+
+1. Look at all the PRs that were assigned to `next-release` throughout the sprint and identify the highest-level of change (major, minor or patch). Deduce the next release's version number and rename the milestone accordingly.
+1. Create a new release notes draft based on the following template: `.github/RELEASE_NOTES_TEMPLATE.md`.
+1. Write the release notes by going through all the issues and PRs assigned to the milestone.
+1. Deploy to production (cf. next section).
+1. Once the library and documentation sites are deployed, publish the release notes and close the milestone.
+1. Share the ZenHub milestone report with stakeholders.
+
+**See more Notes about the release process in the release.md section in docs:**
+[Docs section](https://github.com/unimelb/pattern-lib/tree/master/docs)
+
 ## Deployment
 
-### dev:
+To deploy to production:
+
+1. Bump the `version` number in `package.json` (cf. note below).
+1. Commit the version change to the `dev` branch.
+1. Create a pull request to merge the `dev` branch into `master` - e.g. "Deploy v1.0.1".
+1. Wait for the mandatory checks to pass then select "Rebase and merge" (cf. note below).
+
+Semaphore then automatically builds the library and syncs the output files to S3. If the version you're deploying had been previously deployed, you'll need to invalidate the files on the CDN (AWS Cloudfront) or wait a day or so for this to happen automatically. Once the library is deployed, follow the release process below.
+
+> **Note on versioning**: the version number follows the [semver](http://semver.org/) convention `MAJOR.MINOR.PATCH`, where: `MAJOR` corresponds to a breaking change (e.g. a change in a component's markup), `MINOR` to a new feature (e.g. a new component, a new feature for an existing component, etc.), and `PATCH` to a bug fix or under-the-hood change (e.g. code clean-up, performance improvement, etc.)
 
-1. Create a pull request of your branch into `dev`
-2. Wait for the mandatory checks to pass then select "Squash and merge" following the [commit message format](#commit-message-format). 
+> **Note on rebase**: rebasing `dev` onto `master` avoids creating a merge commit that would require merging `master` back into `dev`.
 
-> It will trigger the `develop` server in semaphore ci generating all the files into the s3 bucket `latest` and also a version number into [Pattern-lib npm](https://www.npmjs.com/package/@unimelb/pattern-lib-vue) for the dev branch with tag `dev`
+### Semi-automatic deployment to dev
 
-### production (master):
+Pre-release builds can be created like this (using the git pre-push hook behind the scenes):
 
-1. Create a pull request to merge the `dev` branch into `master` - e.g. "Merge dev into master".
-2. Wait for the mandatory checks to pass then select "Merge".
+1. Check out a clean `dev` branch
+1. in bash `git push`
+  - This will increment the pre-release version number and make a commit to your local repository
+1. in bash `git push` again
+  - You will be prompted that this will trigger a build. Answer 'y'
+  - This will push (only) your version number change commit to the remote `dev` repo
+1. After the normal checks a build with the new version will be triggered by Semaphore
 
-> It will trigger the `production` server in semaphore ci generating all the files into the s3 bucket `version number determined by semantic release` and also a version number into [Pattern-lib npm](https://www.npmjs.com/package/@unimelb/pattern-lib-vue) for the dev branch with tag `latest`
+> **Note on pre-release versions**: These are legitimate [semver](http://semver.org/) versions. They have the format MAJOR.MINOR.PATCH-beta.NUMBER. **Only** these pre-release versions will be published on `dev`.
 
 ## Testing
 
@@ -179,6 +201,7 @@ For your own sanity, make sure to install your code editor's ESLint and stylelin
 Supported browsers:
 
 - last two versions of Chrome, Firefox and Edge
+- IE 11
 - Safari 8+
 - iOS 8.4+
 - Android 4.4+
@@ -210,4 +233,4 @@ If you wish to update the snapshots with your changes run `yarn test:e2e:updates
 - [University Home Page](https://unimelb.edu.au)
 - [About Us](https://about.unimelb.edu.au)
 - [Brand Hub](https://brandhub.unimelb.edu.au)
-- [MSpace](https://mspace.unimelb.edu.au)
+- [MSpace](https://mspace.unimelb.edu.au)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unimelb/pattern-lib-vue",
   "description": "A complete design system for the University of Melbourne.",
-  "version": "11.1.2",
+  "version": "11.2.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/unimelb/pattern-lib.git"
@@ -9,7 +9,7 @@
   "author": "The University of Melbourne",
   "license": "UNLICENSED",
   "engines": {
-    "node": ">=12.0.0",
+    "node": ">=10.0.0",
     "yarn": "*"
   },
   "main": ".out/vue.js",
@@ -38,8 +38,7 @@
     "test:updatesnapshots": "run-s build start:updatesnapshots",
     "generate": "plop --plopfile generator/index.js",
     "prepublish": "cross-env LOAD_EXTERNAL_ASSETS=true npm run build:vue",
-    "serve:test": "serve .out/docs",
-    "semantic-release": "semantic-release"
+    "serve:test": "serve .out/docs"
   },
   "dependencies": {
     "babel-polyfill": "^6.26.0",
@@ -63,9 +62,6 @@
     "vue-scrollto": "^2.17.1"
   },
   "devDependencies": {
-    "@semantic-release/git": "^9.0.1",
-    "@semantic-release/github": "^7.2.3",
-    "@semantic-release/npm": "^7.1.3",
     "@storybook/addon-notes": "^3.4.8",
     "@storybook/addon-options": "^3.4.8",
     "@storybook/addons": "^3.4.8",
@@ -122,7 +118,6 @@
     "puppeteer": "^2.1.1",
     "raw-loader": "^0.5.1",
     "rimraf": "^3.0.2",
-    "semantic-release": "^17.4.7",
     "serve": "^11.3.0",
     "start-server-and-test": "^1.10.11",
     "storybook-readme": "3.1.1",
@@ -178,4 +173,4 @@
       "pre-commit": "cross-env lint-staged"
     }
   }
-}
+}