Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 3.98 KB

BUILDING.md

File metadata and controls

67 lines (48 loc) · 3.98 KB
Raw

Building Lightweight Charts™

The minimal supported version of NodeJS for development is 16.16.

Note: you need to run npm install in both the root directory and the website directory before you can run the lint tests.

Compiling

  • npm run tsc - compiles the source code only (excluding tests)
  • npm run tsc-watch - runs the TypeScript compiler in the watch mode for source code (same as tsc, but in the watch mode)
  • npm run tsc-verify - compiles everything (source code and tests) with composite projects config to ensure that no invalid imports or cyclic deps are found

Bundling

  • npm run rollup - runs Rollup to bundle code
  • npm run build - compiles source code and bundles it (as one word for npm run tsc && npm run rollup)
  • npm run build:prod - the same as npm run build, but also bundles production (minified) builds

Testing

  • npm run lint - runs lint for the code
  • npm run test - runs unit-tests

There are several included e2e tests available which can be run individually. Please have a read through the following document for further information: /tests/README.md

Tips

  • You can use the following command to make sure that your local copy passes all (almost) available checks:

    npm run verify

  • If you want to play with a locally built package, you can create a debug.html page: cp debug.html.example debug.html.

    This file (debug.html) is under gitignore, so you don't need to worry about changing it and you can modify it as you wish.

Deploying a new version

  1. Update any documentation pages which refer to a specific version. For example, the Android and iOS pages (only if the mobile package version is also updated).
  2. Run npm run docusaurus docs:version MAJ.MIN in website folder to create new versioned docs. Note that there is not patch version in docs, only major and minor parts.
  3. (optional) Remove docs for the oldest version (see https://docusaurus.io/docs/versioning#deleting-an-existing-version).
  4. Handle the new version in import-lightweight-charts-version.ts: add a package reference for that version to website/package.json (e.g. "lightweight-charts-MAJ.MIN": "npm:lightweight-charts@~MAJ.MIN.0") and a import of that package in a matching case statement.
  5. Bump lightweight-charts package version in website/package.json file.
  6. Add all created files to git and commit changes. Note that at this step the website cannot work since it uses unpublished so far version. It will be fixed in the next steps.
  7. Create a git tag for this version with the format vMAJ.MIN.PATCH (see other tags).
  8. Run npm run prepare-release in the root folder.
  9. Run npx publint and ensure that there aren't any issues with the generated package.json.
  10. Run npm publish to publish changes to npm.
  11. Revert changes made in package.json file after prepare-release script.
  12. Bump the library's version in root package.json file to the next one (either major or minor depending on the planning and expected breaking changes).
  13. Push the changes back to github (don't forget to push tags).
  14. Create and publish a release on github.
  15. Close the milestone.

Deploying a pre-release version

These steps are similar to those listed above except that we don't need to do anything related to the documentation site. There isn't typically anything to commit to the repo when doing these steps.

  1. Checkout master branch.
  2. Update package.json, set version to a prerelease version, e.g. 2.0.0-rc1, 3.1.5-rc4,...
  3. Run npm run prepare-release in the root folder.
  4. Run npx publint@latest and ensure that there aren't any issues with the generated package.json.
  5. Run npm publish --tag next to publish changes to npm. Use --dry-run if you are unsure.
  6. Assign the same version number to a git tag for the latest commit in GitHub.
  7. (Optional) Create and publish a release on github.
  8. Discard any changes locally, to ensure you don't commit the modified package.json at a later stage.