@openfin/ui-library 0.14.1-alpha.1680266745 → 0.14.1-alpha.1680270978
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 +8 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -191,32 +191,16 @@ npm run test
|
|
|
191
191
|
|
|
192
192
|
### 1. Create a release branch
|
|
193
193
|
|
|
194
|
-
|
|
194
|
+
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`.
|
|
195
195
|
|
|
196
|
-
|
|
197
|
-
# Fetch and merge latest main branch
|
|
198
|
-
$ git checkout main && git pull
|
|
199
|
-
|
|
200
|
-
# Create new release branch
|
|
201
|
-
$ git checkout -b release/<new-version-number>
|
|
202
|
-
|
|
203
|
-
# Commit new version
|
|
204
|
-
$ npm version <major|minor|patch>
|
|
205
|
-
|
|
206
|
-
# Push release branch remotely
|
|
207
|
-
$ git push -u origin release/<new-version-number>
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
### 2. Create a pull request
|
|
211
|
-
|
|
212
|
-
You should now be able to open a pull request with `release/<new-version-number>` against `main`. Get that approved and merged.
|
|
213
|
-
|
|
214
|
-
### 3. Create a new release on Github
|
|
196
|
+
### 2. Create a new release on Github
|
|
215
197
|
|
|
216
|
-
Once
|
|
198
|
+
Once you have created the release branch, you should now create a release through github:
|
|
217
199
|
|
|
218
200
|
- Click [Create a New Release](https://github.com/openfin/ui-library/releases/new)
|
|
219
|
-
-
|
|
220
|
-
-
|
|
201
|
+
- Create a new tag, labelled `<new-version-number>`. (for example `0.14.3`)
|
|
202
|
+
- Change the target branch to the release branch you just created.
|
|
203
|
+
- Enter the release title to match the tag you just created. (for example `0.14.3`)
|
|
204
|
+
- In the description, enter the changelog from the previous tag. (for example if previous tag is `0.13.0` then `0.13.0...0.14.3`) (Don't worry, you can always go back and edit the description later.)
|
|
221
205
|
|
|
222
|
-
This triggers a Github Action to automatically build the latest version of the `ui-library` and package it for remote installation.
|
|
206
|
+
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