Chart.js/MAINTAINING.md
Josh Kelley 3671c01c26
Distribute types as is (#8720)
I had initially seen some oddities around type augmentation for type definitions in subdirectories of `types`, and using Rollup seemed to help with that. However, now that all of Chart.js's main types are directly under `types`, there seems to be no need for this.

This simplifies the build process, since it no longer needs to use rollup-plugin-dts.

It also improves some third-party tools. For example, I'm in the habit of using WebStorm's "Go To Declaration or Usages" hotkey with third-party TypeScript definitions as a quick way of getting more information about an API. With the Rollup-generate types, that works poorly; WebStorm goes to the imported-and-re-exported symbol within the barely-readable machine-generated dist/chart.esm.d.ts file, and I have to navigate two more hops to find the actual definitions.
2021-03-25 15:08:00 -04:00

1.1 KiB

Maintaining

Release Process

Chart.js relies on Travis CI to automate the library releases.

Releasing a New Version

  1. Update the release version on GitHub for the release drafted by the release-drafter tool
  2. Publish the release
  3. follow the build process on GitHub Actions

Creation of this tag triggers a new build:

  • Chart.js.zip package is generated, containing dist files and examples
  • dist/*.js, types/*.ts, and Chart.js.zip are attached to the GitHub release (downloads)
  • A new npm package is published on npmjs

Finally, cdnjs is automatically updated from the npm release.

Further Reading