trucks-psd-v3 v3.14.0
trucks-psd-v3
Date 2023/12/1
Stores and Retrieves Particle Size Distribution Data for TruckMetrics
API Document
https://apidocs.metricsmanagerstaging.com/trucks-psd-v3/
Getting started for developers
Copy
trucks-psd-v3.env
from \motionmetrics.net\i2l\Bamboo_Files\MMPro_Env\I2L-Staging and rename it as .envCopy
.npmrc
from \motionmetrics.net\i2l\Bamboo_Files\MMPro_Env\I2L-StagingInstall all the dependencies with the command:
npm ci
Verify Segmentation-Service-Python is running locally or as a Docker container at
localhost:7199/fmsegmentation/v2/help
- If it is not set up on your device, follow the installation steps outlined within the segmentation-service-python repository
Run Unit test
npm test
- Compile the typescript to javascript and run lint
npm run-script build
- Start the program
npm start
Commit Message Format - Angular Convention
(): │ │ │ │ │ └─⫸ Summary in present tense. Not capitalized. No period at the end. │ │ │ └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core| │ elements|forms|http|language-service|localize|platform-browser| │ platform-browser-dynamic|platform-server|router|service-worker| │ upgrade|zone.js|packaging|changelog|docs-infra|migrations| │ devtools │ └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test see https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format for more details
Alternatively, you can use the module commitizen
to help you format the commit message.
1. install commitizen
npm install -g commitizen
- making your repo commitizen-friendly
commitizen init cz-conventional-changelog --save-dev --save-exact
- commit your changes
Simply use
git cz
or justcz
instead ofgit commit
when committing. You can also usegit-cz
, which is an alias forcz
.
git add .
git cz
see https://github.com/commitizen/cz-cli for more details
Versioning and changeLog
semantic-release will be implemented once the node version meets the minimum required version 1. Update the CHANGELOG.md file with the new version and changes
- Update the version new feature increment the minor version bug fix and typo increment the patch version
npm version <major|minor|patch>
Running Integration Tests
Copy the
npm-qc-user-credentials.env
from NAS, and save it to the IntegrationTest folder and rename it as .envRepeat Steps in "Getting started for developer" if you haven't done
Run the Integration Test:
npm run-script integration-test
Releasing APIdoc
- Install apidoc if you haven't
npm install -g apidoc
- Run the below command in the vs code terminal
apidoc -i ./ -o apidoc/ -f ".*\.ts$" -e node_modules/ -e apidoc/
- Open apidoc folder of your project in file explorer or finder
- Verify the correctness of the content by opening
index.html
- Copy and paste the content in the folder to the project folder in
\\motionmetrics.net\i2l\Bamboo_Files\APIDocs
- New version will be pushed to
apidoc.metricsmanagerstaging.com
at midnight
Bitbucket Repository variables
The variables defined in the repository for the bitbucket-pipelines are:
- SERVICE_NAME - trucks-psd-v3
- NPMRC_base64 - the base64 encoded .npmrc which defines the authtoken for registry.npmjs.org
- ENV_QC_I2LStaging_base64 - the base64 encoded .env for I2L-staging deployments for QC tests
To create the base64 encoded strings use:
base64 --wrap=0 staging.env > staging.b64
base64 --wrap=0 production.env > production.b64
Note
We are currently using Node LTS v16.13.0