Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.48 KB

DEV_DOCS.md

File metadata and controls

29 lines (20 loc) · 1.48 KB

Build

This package has two main parts: the lib code in /projects/angular2-smart-table and the demo application that contain a live demo for the lib and the settings documentation as an angular application /projects/demo/.

  • To setup your development environment we first must ensure that you are running node version equal or greater than v12.
  • Then install the application dependencies using npm install command.
  • After that run the build script in order to build the lib and the demo application.

You can use start script to run the demo for debugging your changes in the library's core.

Release

  1. For major version, search for @breaking-change to make sure all breaking changes are covered.

To start a new release (publish the framework packages on NPM) you need:

  1. create a new release branch called release/{version} where {version} is in 1.6.0 format -> git checkout -b release/{version}
  2. npm run build:lib to make sure the lib is building
  3. MANUALLY update a version in main ./package.json & in ./projects/angular2-smart-table/package.json
  4. MANUALLY copy the CHANGELOG.md from the root dir to ./projects/angular2-smart-table/src/
  5. commit with release/{version} message -> git commit -m release/{version}
  6. push, create PR, approve & merge
  7. pull changes and release with npm run publish
  8. update docs with npm run docs:gh-pages
  9. create git tag {version} and push it with git push --tags