Team responsible: Engineering Enablement team
To produce a Node.js command that copies and save valid markdown documents from the development-standards repository.
This repo uses the ee-react-template project template. Any frontend features have been removed.
The starter contains the following scripts:
import [dir]
- starts the import; [dir] is optional, replace it with your directory of choice, otherwise it defaults todocs
build
- generates the production bundletest
- starts vitest and runs all teststest:coverage
- starts vitest and run all tests with code coverage reportlint:scripts
- lint.ts
,.tsx
and.json
files with eslintformat:scripts
- format.ts
,.html
and.json
files with prettierformat
- format all with prettierprepare
- script for setting up husky pre-commit hookuninstall-husky
- script for removing husky from repository
Simply create and submit a pull request. You can also contact us via Teams (DV - Engineering Enablement) or Slack (#engineering-enablement).
This project uses Release it! to automate versioning and utilizes Commitizen to generate consistent and meaningful changelogs.
There is a demo repository available with an explanation and some example flows.
In short:
- Features and bug fixes should be merged into
develop
with a Commitizen friendly commit message. - When generating a new release, a new branch
release/[branch-name]
should be created fromdevelop
. In GitHub this will trigger theRelease
action, which will run Release it! Then the branch can be merged tomain
. - Don't forget to merge
main
back intodevelop
when complete.
The release/[branch-name]
step is crucial, as you may have other important actions listening to the main
branch, like deploying or publishing your latest application. If the Release
action were to run on main
, it would effectively mean your actions are triggered twice, as it generates another commit.