@openfin/ui-library 0.14.1-alpha.1680266745 → 0.14.1-alpha.1680287202

package/README.md

@@ -116,6 +116,8 @@ Also keep in mind, UI Library is a home of centralized common components, **used
 
 Meaning: While there are no hard rules about what belongs in _our_ library, if a change is too opinionated or too specialized, it may make sense to leave it out. **A library that does less, is a lot easier to know and work with**.
 
+**Please be sure to update the package version before submitting your pull request.** If you are unsure what the new verison should be, please refer to [Semantic Versioning](https://semver.org/).
+
 ### Storybook
 
 Great for exploring and experimenting with UI Library components. It's also used for [testing our components](https://storybook.js.org/docs/react/workflows/unit-testing).
@@ -191,32 +193,16 @@ npm run test
 
 ### 1. Create a release branch
 
-Note the new release version, and create a branch from `main` solely for versioning:
-
-```sh
-# Fetch and merge latest main branch
-$ git checkout main && git pull
-
-# Create new release branch
-$ git checkout -b release/<new-version-number>
-
-# Commit new version
-$ npm version <major|minor|patch>
-
-# Push release branch remotely
-$ git push -u origin release/<new-version-number>
-```
-
-### 2. Create a pull request
-
-You should now be able to open a pull request with `release/<new-version-number>` against `main`. Get that approved and merged.
+Once all PRs meant for a release are merged into `main` branch, you should now create a new release branch in github. To do so, go to the [list of branches](https://github.com/openfin/ui-library/branches) and click 'New Branch.' Name the new branch `release/<new-version-number>` (for example `release/0.14.3`) and make sure the branch source is `main`.
 
-### 3. Create a new release on Github
+### 2. Create a new release on Github
 
-Once your release branch is merged into main, you should now create a release through github:
+Once you have created the release branch, you should now create a release through github:
 
 - Click [Create a New Release](https://github.com/openfin/ui-library/releases/new)
-- Enter the version name as the tag and the release title
-- Enter a description that includes all feature ticket numbers that were included since the previous release. Don't worry, you can always go back and edit it later.
+- Create a new tag, labelled `<new-version-number>`. (for example `0.14.3`)
+- Change the target branch to the release branch you just created.
+- Enter the release title to match the tag you just created. (for example `0.14.3`)
+- In the description, enter the changelog from the previous tag. (for example if previous tag is `0.13.0` then your description should be "Change log: `https://github.com/openfin/ui-library/compare/0.13.0...0.14.3`") (Don't worry, you can always go back and edit the description later.)
 
-This triggers a Github Action to automatically build the latest version of the `ui-library` and package it for remote installation. Check the status of this task within this repo's actions tab.
+This triggers a Github Action to automatically build the latest version of the `ui-library` and package it for remote installation. You can check the status of this task within this repo's actions tab.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openfin/ui-library",
   "description": "OpenFin UI Component Library",
-  "version": "0.14.1-alpha.1680266745",
+  "version": "0.14.1-alpha.1680287202",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "github:openfin/ui-library",