This is a template repo that will get you writing a TypeScript Node application in not time. Click here to create a new repo with this template.
Use this template by clicking here and cloning your new repository
npm test
Testing has been set up using jest and ts-jest.
Run tests with npm test
. Coverage is turned on and thresholds set to 80%. Test files must be named
<name>.test.ts
and placed in the test
in the root of the project.
npm run build
This will clean the build
directory and recompile the TypeScript code into the build
directory.
Prettier is ran against all .ts
, .js
, .md
, .json
, and .yaml
files with the --write
flag, so files will be corrected and re-staged.
All tests are ran before the commit is initialized.
This project is set up with commitizen. To commit changes,
stage your changes with git add
. Then initialize the commit with git commit
and you will be prompted
with the commitizen Conventional Changelog commit message options. Complete the prompts given by commitizen,
review your message in the default git commit message composer, and finally save. (Don't for get to push)
A Github Action is ran on every pull request creation and push to an open PR that will build, test, and archive the test coverage as an artifact of the build.
- Explain VSCode Launch Tasks
- Create master branch merge Github Action
- Explore linting options
Runs things
Runs tests and such Create release tag
VARIABLE=$(git show -s --date=format:'%Y%m%d%H%M%S' --format=%cd-%h <SHA>)
push tag
- Create Deployment for tag ref
- Do deployment things
- Update deployment status
Want to do:
- Use tag compare links in deployment some how
https://github.com/colevoss/terraform-ops/compare/test-tag-a...test-tag-two