@unimelb/pattern-lib-vue 14.5.3 → 14.6.0

package/README.md

@@ -143,47 +143,43 @@ For your own sanity, make sure to install your code editor's ESLint and stylelin
 
 - 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.)
+- Assign additional labels to issues when relevant (e.g. `deprecated`, `documentation`, etc.)
 
 **At the end of the release sprint:**
 
+> [!NOTE] > **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. 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. 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 `Create a merge commit`
 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
-
-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 `Create a merge commit`
+1. Share the release on the `design-systems` slack channel using the following template:
 
-Github Actions 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.
+```
+@channel new `gen2` version `vx.x.x` is out: https://github.com/unimelb/pattern-lib/releases/tag/vx.x.x
+```
 
-> **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.)
+> [!TIP]
+> Github Actions 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.
 
 ### Semi-automatic deployment to dev
 
 Pre-release builds can be created like this (using the git pre-push hook behind the scenes):
 
+> [!NOTE] > **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`.
+
 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` - 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
+   - 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 Github Actions
 
-> **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
 
 ### Testing Pull-requests
@@ -218,7 +214,7 @@ Recommended mobile devices for testing:
 
 ### Visual snapshot testing
 
-You can run visual snapshot testing using `yarn test:snapshots`. This compares your changes against the latest visual snapshot.  Failed snapshot tests will show a visual diff comparison in `snapshots/__tests__/__image_snapshots__/__diff_output__`.
+You can run visual snapshot testing using `yarn test:snapshots`. This compares your changes against the latest visual snapshot. Failed snapshot tests will show a visual diff comparison in `snapshots/__tests__/__image_snapshots__/__diff_output__`.
 
 If you wish to update the snapshots with your changes run `yarn test:e2e:updatesnapshots`.
 
@@ -235,4 +231,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": "14.5.3",
+  "version": "14.6.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/unimelb/pattern-lib.git"