@bigbinary/neeto-team-members-frontend 2.5.19 → 2.5.21

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 CHANGED
@@ -12,13 +12,13 @@ functioning of the package. Install all the peer dependencies using the below
12
12
  command:
13
13
 
14
14
  ```zsh
15
- yarn add @bigbinary/neeto-commons-frontend@2.0.36 @bigbinary/neeto-icons@1.9.11 @bigbinary/neetoui@4.3.3 @honeybadger-io/js@5.1.1 @honeybadger-io/react@5.1.3 axios@1.3.3 classnames@2.3.2 formik@2.2.9 js-logger@1.6.1 ramda@0.28.0 react-helmet@6.1.0 react-query@3.39.3 react-router-dom@5.3.4 react-toastify@8.2.0 yup@1.0.0
15
+ yarn add @bigbinary/neeto-commons-frontend@2.0.36 @bigbinary/neeto-filters-frontend@2.6.13 @bigbinary/neeto-icons@1.9.12 @bigbinary/neetoui@4.4.0 @honeybadger-io/js@5.1.1 @honeybadger-io/react@5.1.3 axios@1.3.4 classnames@2.3.2 formik@2.2.9 js-logger@1.6.1 mixpanel-browser@2.45.0 ramda@0.28.0 react-helmet@6.1.0 react-query@3.39.3 react-router-dom@5.3.4 react-toastify@8.2.0 yup@1.0.2
16
16
  ```
17
17
 
18
18
  2. Now install the latest **neetoTeamMembers** package using the below command:
19
19
 
20
20
  ```zsh
21
- yarn add @bigbinary/neeto-team-members-frontend@2.5.17
21
+ yarn add @bigbinary/neeto-team-members-frontend@2.5.20
22
22
  ```
23
23
 
24
24
  ## Usage
@@ -82,11 +82,27 @@ The configurations for the components present in this NPM package are given belo
82
82
  yarn start
83
83
  ```
84
84
 
85
- ## Building
86
-
87
- The neetoTeamMembers package gets published to NPM only whenever we push the PR to the `main` branch.
88
- By default, we will bump the patch version. If you want to release a minor or major version, then provide the `minor` or `major` label to the PR.
89
- You can checkout the `publish` workflow in GitHub Actions to get a live update.
85
+ # Building and releasing.
86
+
87
+ The `@bigbinary/neeto-team-members-frontend` package gets published to NPM when we
88
+ merge a PR with `patch`, `minor` or `major` label to the `main` branch. The
89
+ `patch` label is used for bug fixes, `minor` label is used for new features and
90
+ `major` label is used for breaking changes. You can checkout the
91
+ `Create and publish releases` workflow in GitHub Actions to get a live update.
92
+
93
+ In case if you missed to add the label, you can manually publish the package.
94
+ For that first you need to create a PR to update the version number in the
95
+ `package.json` file and merge it to the `main` branch. After merging the PR, you
96
+ need to create a
97
+ [new github release](https://github.com/bigbinary/neeto-team-members-frontend/releases/new)
98
+ from main branch. Whenever a new release is created with a new version number,
99
+ the github actions will automatically publish the built package to npm. You can
100
+ checkout the `Publish to npm` workflow in GitHub Actions to get a live update.
101
+
102
+ Please note that before publishing the package, you need to verify the
103
+ functionality in some of the neeto web-apps locally using `yalc` package
104
+ manager. The usage of yalc is explained in this video:
105
+ https://youtu.be/QBiYGP0Rhe0
90
106
 
91
107
  ## Integrations
92
108