We have added a few helpers for your development. There are some scripts for you, and some automation for us. Once you've passed all tests and automation hooks, you can expect an almost instant release.
To get all setup:
npm i
This will get you ready to develop.
Dynamoose has a few helpers for local development. These are included in the scripts section of our package.json.
This will run git-cz, a helper for creating a commit that semantic release can interpret.
This will run our lint configuration against your commit to let you know if it's correct.
This will run all of our tests via a node script. This spins up a local DynamoDB Local instance, runs Mocha, and closes the DynamoDB Local instance at completion.
Same as above, but launched with --inspect. This will allow you to place debugger statements for working in the tests.
Same as above, but launched with --inspect-brk. This will allow you to place debugger statements for working in the tests, and not initialize the tests until you manually start it.
This will run our lint configuration against all of our source files and alert you to any issues.
This will run our lint, test, and coverage scripts. This is exactly what travis runs, if you'd like to verify prior to commit.
We have a few requirements for getting a PR merged. They are:
- Must pass our
eslint - Must have test coverage not decrease
- A well formatted commit message
- An approved review
To make your life super easy, we use husky. If husky passes your commit message, and allows the push you should be able to breeze through all of the above steps.