mirror of
https://github.com/chartjs/Chart.js.git
synced 2024-10-16 00:59:07 +02:00
c26f7b8fcc
* Allow manual triggering of release drafter * Add instructions for patch release
35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
# Maintaining
|
|
|
|
## Release Process
|
|
|
|
Chart.js relies on [Travis CI](https://travis-ci.org/) to automate the library [releases](https://github.com/chartjs/Chart.js/releases).
|
|
|
|
### Releasing a New Version
|
|
|
|
1. Update the release version on [GitHub](https://github.com/chartjs/Chart.js/releases/new) for the release drafted by the `release-drafter` tool
|
|
2. Publish the release
|
|
3. follow the build process on [GitHub Actions](https://github.com/chartjs/Chart.js/actions?query=workflow%3A%22Node.js+Package%22)
|
|
|
|
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](https://www.npmjs.com/package/chart.js)
|
|
|
|
Finally, [cdnjs](https://cdnjs.com/libraries/Chart.js) is automatically updated from the npm release.
|
|
|
|
### Releasing a patch version
|
|
|
|
If there is a need to create a patch version for an older release:
|
|
|
|
1. Create a branch for the patch version (without the `v` prefix)
|
|
2. Cherry pick the needed commit(s) to that new branch from master
|
|
3. Trigger the release-drafter workflow on that branch from the actions.
|
|
4. Follow the procedure for [Releasing a New Version](#releasing-a-new-version)
|
|
|
|
### Further Reading
|
|
|
|
* [GitHub Action releases](https://github.com/chartjs/Chart.js/pull/7891)
|
|
* [dist/* files](https://github.com/chartjs/Chart.js/issues/3033)
|
|
* [cdnjs npm auto update](https://github.com/cdnjs/cdnjs/pull/8401)
|