commons-ui

Library for sharing GridSuite apps commons components

For developers

The commons-ui library have a demo app in which you can call your components to test them. The npm start command install the library's dependencies then launches the demo app.

If you want to test your library integration with a consumer application my-app you have first to build commons-ui via

• npm install (if not already done to get tsc)
• npm run build:pack

Then in the my-app project :

• Change the commons-ui dependency in my-app's package.json from
  @gridsuite/commons-ui:"^x.x.x"
  to
  @gridsuite/commons-ui:"file:{PATH_TO_LIBRARY}/gridsuite-commons-ui-{LIBRARY_VERSION}.tgz"
• npm install
• npm start

Warning : with Create React App, we realised the library was not updating correctly if you try to install the library multiple times. To fix this, run this command from the app after running "npm install"

• rm -Rf node_modules/.cache

For integrators

If you want to deploy a new version of commons-ui in the NPM package registry, you need to follow the steps below:

• Update to the new version in package.json (example 0.6.0)
• Build it: npm install
• Commit the package.json and package-lock.json files, push to a branch, make a PR, have it reviewed and merged to main.
• Make a release on GitHub by creating a new tag on the last commit. On the release creation page:
  • In "Choose a tag": type the tag you want to create (ex.: v0.6.0) and select "create new tag"
  • In "Target": click on "recent commit" tab and select your release commit
  • Click on "Generate release note"
  • Click on "Publish release"
• It will trigger a job that will publish the release on NPM

License Headers and dependencies checking

To check dependencies license compatibility with this project one locally, please run the following command :

npm run licenses-check

Notes :

• Check license-checker-config.json for license white list and exclusion. If you need to update this list, please inform organization's owners.