@bigbinary/neeto-editor 1.22.2 → 1.23.1

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 (3) hide show
  1. package/README.md +22 -6
  2. package/index.js +19 -14
  3. package/package.json +36 -45
package/README.md CHANGED
@@ -22,12 +22,28 @@ yarn
22
22
  Running the `yarn start` command starts a storybook application. Use this
23
23
  application to test out changes.
24
24
 
25
- ## Building
26
-
27
- The neetoEditor package gets auto-published to npm for every new merge to the
28
- main branch. You can checkout the `publish` workflow in git actions to get a
29
- live update.
25
+ # Building and releasing.
26
+
27
+ The `@bigbinary/neeto-editor` package gets published to NPM when we
28
+ merge a PR with `patch`, `minor` or `major` label to the `main` branch. The
29
+ `patch` label is used for bug fixes, `minor` label is used for new features and
30
+ `major` label is used for breaking changes. You can checkout the
31
+ `Create and publish releases` workflow in GitHub Actions to get a live update.
32
+
33
+ In case if you missed to add the label, you can manually publish the package.
34
+ For that first you need to create a PR to update the version number in the
35
+ `package.json` file and merge it to the `main` branch. After merging the PR, you
36
+ need to create a
37
+ [new github release](https://github.com/bigbinary/neeto-editor/releases/new)
38
+ from main branch. Whenever a new release is created with a new version number,
39
+ the github actions will automatically publish the built package to npm. You can
40
+ checkout the `Publish to npm` workflow in GitHub Actions to get a live update.
41
+
42
+ Please note that before publishing the package, you need to verify the
43
+ functionality in some of the neeto web-apps locally using `yalc` package
44
+ manager. The usage of yalc is explained in this video:
45
+ https://youtu.be/QBiYGP0Rhe0
30
46
 
31
47
  ## Documentation
32
48
 
33
- Read the docs here: https://neeto-editor.onrender.com.
49
+ Read the docs here: https://neeto-editor.neeto.com.