@proprioo/salatim 36.3.4 → 36.3.6

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+**36.3.6**
+
+    * chore: move to GitHub actions
+    * ci: add release workflow
+    * ci: add lint and test workflow for PR
+    * chore: remove .npmrc file from repository
+    * doc: update readme with basic info about new workflows in GitHub
+
+**36.3.5**
+
+    * fix adding Indonesia phone
+
 **36.3.4**
 
     * Chore(Phone): add Indonesia

package/README.md

@@ -4,85 +4,69 @@ Salatim is our component library, made with 🥑 and ❤️.
 
 Please have a look on its storybook for each components.
 
-## Before
-
-Don't forget to add an empty NPM_TOKEN in your bash_profile, zsh, etc.. and reload it.
-
-```
-export NPM_TOKEN=''
-```
-
-## Status
-
-![build status](https://gitlab.com/proprioo/frontend/salatim/badges/master/build.svg)
-
-| Branches                                                                                      | Functions                                                                                       | Lines                                                                                   | Statements                                                                                        |
-| :-------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ |
-| ![branches coverage](https://proprioo.gitlab.io/frontend/salatim/coverage/badge-branches.svg) | ![functions coverage](https://proprioo.gitlab.io/frontend/salatim/coverage/badge-functions.svg) | ![lines coverage](https://proprioo.gitlab.io/frontend/salatim/coverage/badge-lines.svg) | ![statements coverage](https://proprioo.gitlab.io/frontend/salatim/coverage/badge-statements.svg) |
-
-## Pages
-
-[Source Map Explorer](https://proprioo.gitlab.io/frontend/salatim/explorer/)
-
-[Storybook](https://proprioo.gitlab.io/frontend/salatim/storybook/)
-
 ## How to dev ?
 
-Use `yarn dev`
-
-## How to build ?
-
-Use `yarn build`
-
-## Update version
-
-Before each change, please update `CHANGELOG.md` with a new version using the following template:
+- create a branch from `main`
+- make changes and sane commits (atomic, descriptive)
+- push changes and create a PR on GitHub
+- once complete, merge it to `main` using "Rebase and merge" strategy
 
-```markdown
-**major.minor.patch**
+**WARNING**: some checks are not yet executed on PR, make sure to run locally:
 
-    * Commit message
-
-    OR
-
-    **BREAKING CHANGE** Commit message
+```
+$ yarn lint
+$ yarn storybook:build
+...
 ```
 
-- Fix: **patch**
-- Component / Feature: **minor**
-- Everything which can bring changes in the different projects: **major**
+## How to release a new version?
 
-When changelog is updated, don't forget to bump the `package.json` version with:
+Final "production" release of salatim are managed through npmjs.com -- https://www.npmjs.com/package/@proprioo/salatim
 
-```
-$ yarn version --major | --minor | --patch
-```
+To publish a new version of salatim, you need to:
 
-## Release new version
+- checkout the `main` branch
+- make sure everything is up to date with `git pull origin main`
+- [optional by now] update the `CHANGELOG.md` file according to the changes you made since the last release
+- create either a **patch**, **minor** or **major** release depending on the changes you made using yarn
+  - i.e. `yarn version --patch` for a patch release
+  - i.e. `yarn version --minor` for a minor release
+  - i.e. `yarn version --major` for a major release
+- push the commit and the tag created by the previous command using `git push origin main --tags`
+- go to GitHub and create a new release from the tag you just pushed
 
-Pushing a new version in the `master` branch automatically trigger a new release of the NPM package.
+**WARNING**: the GitHub workflow to push the package to npmjs.com is currently untested, make sure to verify the
+package is correctly published on npmjs.com after the release.
 
-## Backport a fix
+## **OUTDATED, TO BE CHECKED** Backport a fix
 
 If you have to backport something to an old version of salatim :
 
 1. go to the old version's branch (for example: `v15` before the rebranding)
-2. add your commit(s), and don't forget to bump the version in `package.json` and `CHANGELOG.md` (if you fix something and the previous version was `15.2.3`, bump to `15.2.4`)
+2. add your commit(s), and don't forget to bump the version in `package.json` and `CHANGELOG.md` (if you fix something
+   and the previous version was `15.2.3`, bump to `15.2.4`)
 3. push the branch, don't forget it!
 4. run `yarn clean && yarn build` locally to make the package ready to be published
-5. run `yarn publish --access=public --non-interactive --tag 15.2.4` locally. **Don't forget the `--tag` argument to prevent overriding the latest version.**
+5. run `yarn publish --access=public --non-interactive --tag 15.2.4` locally. **Don't forget the `--tag` argument to
+   prevent overriding the latest version.**
 
 You can then bump your project with this new version of salatim. ;)
 
 ## Update phone metadata
 
 We cannot accept every phone numbers in the application, mainly due to some optimization (Metadata JSON is a big file).
-When an error is triggered on AppSales (`Failed to parse phone number +XXXX`), we need to update the phone Metadata to accept it.
+When an error is triggered on AppSales (`Failed to parse phone number +XXXX`), we need to update the phone Metadata to
+accept it.
 
 1. Find the country calling code, to do so:
-   1. Go to [Phone.tsx](./packages/phone//src/phoneInput/PhoneInput.tsx), change `PhoneInput` import to `'react-phone-number-input'` and remove metadata attribute in JSX (like this we're accepting every possible phone numbers)
+   1. Go to [Phone.tsx](./packages/phone//src/phoneInput/PhoneInput.tsx), change `PhoneInput` import to
+      `'react-phone-number-input'` and remove metadata attribute in JSX (like this we're accepting every possible phone
+      numbers)
    2. Start locally Storybook and copy / paste your troublesome phone number to find the country calling code.
 2. Go to [CountryCode.org](https://countrycode.org/) and find your country calling code.
-3. Use the 2 digit ISO found to update the script [generate-phone-metadata](./package.json), then run this script (Metadata will be automatically generated).
-4. We also need to update the Phone component to accept this new option, go to [constants](./packages/phone/src/phoneInput/constants.ts) and add this 2 digit ISO in both constants.
-5. Do not forget to rollback your changes in `PhoneInput.tsx`, then update Changelog.md and package.json version and you're up to go.
+3. Use the 2 digit ISO found to update the script [generate-phone-metadata](./package.json), then run this script (
+   Metadata will be automatically generated).
+4. We also need to update the Phone component to accept this new option, go
+   to [constants](./packages/phone/src/phoneInput/constants.ts) and add this 2 digit ISO in both constants.
+5. Do not forget to rollback your changes in `PhoneInput.tsx`, then update Changelog.md and package.json version and
+   you're up to go.