@equinor/procosys-webapp-components
v6.1.6
Published
Library for sharing components and modules between Procosys MC webapp, Comm webapp and Echo.
Downloads
402
Readme
This library exists to share visual components as well as entire modules between the Procosys MC webapp, commissioning webapp and other Equinor solutions, such as Echo Infield.
These are the existing and planned modules:
- Attachments
- MCCR checklists
- Tag OCR (pending major upgrade)
- CPCL checklists (planned)
- Punch (planned)
- Commissioning Action log (planned)
- Commissioning Tasks (not planned, but expected)
Most modules require your app, represented by an Azure App Registration, to have access to the relevant Procosys API. Please contact the Procosys team to obtain this access.
How to use this library:
- Run "yarn" in the root of this repo
- Run "yarn link"
To link to this library
- Run "yarn start"
- Run "yarn link @equinor/procosys-webapp-components" in the app you want to test the code in.
To unlink
- Run "yarn unlink @equinor/procosys-webapp-components" in the app you tested the code in.
For info on how to contribute and publish changes to the package, please check out the guide in the Procosys Wiki Frontend section.
Installing the package
This package is published to npmjs.com under the @equinor scope, alongside the EDS packages (@equinor/eds-*) and other @equinor dependencies.
Install the package:
yarn add @equinor/procosys-webapp-componentsor
npm install @equinor/procosys-webapp-components
No .npmrc or auth token is required for installing, since the package is public on npmjs.com.
Publishing
Publishing is automated via the 📦 Publish package GitHub Actions workflow (.github/workflows/publish.yml). On every push to main, the workflow builds the package and publishes it to npmjs.com only if the version in package.json has not already been published. This means routine commits to main won't fail when the version is unchanged.
To release a new version:
- Bump the
versionfield inpackage.json. - Merge to
main. The workflow publishes the new version automatically.
Authentication (Trusted Publisher / OIDC)
Publishing uses npm's Trusted Publisher (OIDC) feature, so no npm token is required. The workflow authenticates tokenlessly via GitHub Actions OIDC (id-token: write permission). The package on npmjs.com must have this repository and the publish.yml workflow configured as a Trusted Publisher.
