Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.18 KB

DEVELOPER.md

File metadata and controls

45 lines (30 loc) · 1.18 KB

Developing, Building, Testing and Deploying

Developing

npm run dev:demo

Open http://localhost:3000/ to see the demo browser.

Testing

npm run test

Commit Message Guidelines

The commits must be Commitizen friendly. There is no commit message validation, so make sure your commits stuck to the guidelines before pushing.

Building and Deploy the Docs

Building and deploying the docs is done automatically via GH Actions for the branches dev and master.

Releasing

Automatic

Use script at .github/release.sh and replace X.X.X with the version:

./.github/release.sh X.X.X

Manual

  1. Make sure you're in a clean git state (git status should report "nothing to commit").
  2. Bump the version numbers in both package.json and lib/ng-vcl/package.json.
  3. Run npm run changelog to update CHANGELOG.md.
  4. Run npm run build to build the library.
  5. Commit with the message chore: release.
  6. Create a tag using git tag vX.X.X replacing X.X.X with the version.
  7. Push commit using git push --all (to include tags)
  8. Publish the release npm run publish