@studyportals/sp-lord-business-interface

sp-lord-business-interface

Typescript library containing resources that facilitate integration with Lord Business.

Testing

This project is covered by a regression suite of unit tests. To run the regression suite execute the npm run test-u command. To run the regression suite and generate a coverage report execute the npm test command.

Uncovered lines

The coverage report will indicate towards lines that have not been covered by the regression suite. The line numbers specified in the coverage report represent the lines numbers in the Typescript source files.

Enforcement

A difference cover of at least 95% is required for a Pull Request to be merged.

Deployment

This project is deployed as the npm package @studyportals/sp-lord-business-interface. The npm run deploy carries out the deployment of the project: it recompiles the project, executes the regression suite and publishes the binaries. This command does not increment the package's version and should generally not be used by itself.

Stable branch

If your changes are ready for production usage, use one of the following commands to increment the version and release to the stable branch:

• npm run deploy-patch
• npm run deploy-minor
• npm run deploy-major

Beta branch

If your changes have not yet been fully approved for the stable branch, but you would still like to make them accessible to facilitate other development efforts, use the following command to acquire a release candidate version and release to the beta branch:

• npm run deploy-beta