@dvsa/cvs-microservice-common
v1.2.4
Published
Common package to be used in CVS microservices
Downloads
705
Readme
cvs-microservice-common
Common code used by the various serverless microservices within the Commercial Vehicle Services (CVS) system, published as a GitHub package.
Pre-requisites
- Node.js (Please see
.nvmrc
for specific version) npm
(If using n or nvm, this will be automatically managed)- Security
- Git secrets
- ScanRepo
- Unzip
repo-security-scanner_<version>_Darwin_<architercture>.tar.gz
and rename the executable inside the folder toscanrepo
- Add executable to path (usingecho $PATH
to find your path)
- Unzip
Getting started
Run the following command after cloning the project
npm install
(ornpm i
)
The code that will be published lives inside the ./src directory.
If wishing to add new top level directories to the output, then they must be included in the files
array inside package.json
as well as included in the clean:temp
command.
Publishing
In order to see the output of what will be published, run the following command:
npm publish --dry-run
There are two ways in which this package can/should be published:
Requires manual version bump via the PR
- Upon merge into
main
branch, the package will be published via a GHA workflow.