@hazelcast/ui 3.0.13 → 3.1.0

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.
Files changed (2) hide show
  1. package/README.md +7 -37
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -29,7 +29,7 @@ Design system built with A11Y in mind. Developed as a [Lerna](https://lerna.js.o
29
29
  - [Run visual regression tests](#run-visual-regression-tests)
30
30
  - [Approve the updated for visual regression test screenshots](#approve-the-updated-for-visual-regression-test-screenshots)
31
31
  - [Run all checks at once](#run-all-checks-at-once)
32
- - [Releasing a new version](#releasing-a-new-version)
32
+ - [Releasing](#releasing)
33
33
 
34
34
  <!-- END doctoc generated TOC please keep comment here to allow auto update -->
35
35
 
@@ -189,42 +189,12 @@ pnpm run verify-all
189
189
 
190
190
  If you PR passes this check locally, it is almost guaranteed to pass it on the CI.
191
191
 
192
- ## Releasing a new version
192
+ ## Releasing
193
193
 
194
- Assuming you're on latest master and the build is alright (`pnpm run build` runs without errors).
194
+ `v3` is the current stable line, published to npm under the `latest` dist-tag (development of the next major continues on `master`, published under `canary`).
195
195
 
196
- 1. First we create a release branch for the next version locally (in this case v1.1.0):
196
+ Releases are triggered manually via the ["prepare release" GitHub Actions workflow](.github/workflows/prepare-release.yml):
197
197
 
198
- ```
199
- git checkout -b release/v1.1.0
200
- ```
201
-
202
- We push this new branch to Github:
203
-
204
- ```
205
- git push -u origin release/v1.1.0
206
- ```
207
-
208
- 2. Then we run:
209
-
210
- ```
211
- pnpm exec lerna version 1.1.0
212
- ```
213
-
214
- This updates the package versions (in package.json, package-lock.json), creates a commit with necessary tags and pushes to Github automatically.
215
-
216
- At this point you should create a pull request and merge the new version branch (v1.1.0) to master.
217
-
218
- 3. Now, after merging this pull request, we have the latest version available on GitHub. And it will be automatically published to npm with the required tags and releases;
219
-
220
- Wait for a few seconds/minutes (depends on how busy npm is at the time), and you should see the latest version we just released in the list returned by:
221
-
222
- ```
223
- pnpm view @hazelcast/ui versions
224
- ```
225
-
226
- If something went wrong and npm did not create a new release, then you can manually inform it about our new release:
227
-
228
- ```
229
- pnpm exec lerna publish from-git
230
- ```
198
+ 1. Run the workflow (`workflow_dispatch`) against the `v3` branch with the desired version bump type.
199
+ 2. It opens a PR bumping the version and enables auto-merge.
200
+ 3. Once a code owner approves and it merges, npm publish and git tagging happen automatically.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hazelcast/ui",
3
- "version": "3.0.13",
3
+ "version": "3.1.0",
4
4
  "description": "Hazelcast design system components and utilities",
5
5
  "homepage": "https://github.com/hazelcast/hive#readme",
6
6
  "bugs": {