@openfin/ui-library 0.15.0-alpha.1682958382 → 0.15.0-alpha.1682958396
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -191,18 +191,22 @@ npm run test
|
|
|
191
191
|
|
|
192
192
|
## Versioning & Releasing
|
|
193
193
|
|
|
194
|
-
### 1.
|
|
194
|
+
### 1. Bump package version
|
|
195
195
|
|
|
196
|
-
Once all PRs meant for a release are merged into `main` branch, you should now create a new
|
|
196
|
+
Once you are ready to make a new release and all PRs meant for a release are merged into `main` branch, you should now create a new PR into `main` to bump the package version to the appropriate number. Get that PR approved and merged into `main`.
|
|
197
197
|
|
|
198
|
-
### 2. Create a
|
|
198
|
+
### 2. Create a release branch
|
|
199
|
+
|
|
200
|
+
Now that the package version is up to date, 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`.
|
|
201
|
+
|
|
202
|
+
### 3. Create a new release on Github
|
|
199
203
|
|
|
200
204
|
Once you have created the release branch, you should now create a release through github:
|
|
201
205
|
|
|
202
206
|
- Click [Create a New Release](https://github.com/openfin/ui-library/releases/new)
|
|
203
207
|
- Create a new tag, labelled `<new-version-number>`. (for example `0.14.3`)
|
|
204
|
-
- Change the target branch to the release branch you just created.
|
|
208
|
+
- Change the target branch to the release branch you just created. (for example `release/0.14.3`)
|
|
205
209
|
- Enter the release title to match the tag you just created. (for example `0.14.3`)
|
|
206
|
-
- In the description, enter the changelog from the previous tag. (for example if previous tag is `0.
|
|
210
|
+
- In the description, enter the changelog from the previous tag. (for example if previous tag is `0.14.2` then your description should be "Change log: `https://github.com/openfin/ui-library/compare/0.14.2...0.14.3`") (Don't worry, you can always go back and edit the description later.)
|
|
207
211
|
|
|
208
212
|
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
CHANGED