Chart.js/MAINTAINING.md

# 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)
Describe the release process 2016-08-28 17:34:22 +02:00			`# Maintaining`
Add markdown linting, fix errors (#8449) 2021-02-18 14:17:39 +01:00
Describe the release process 2016-08-28 17:34:22 +02:00			`## Release Process`
Add markdown linting, fix errors (#8449) 2021-02-18 14:17:39 +01:00
Describe the release process 2016-08-28 17:34:22 +02:00			`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`

Expand filename (#7893) * Fix double env * Properly expand name in attach step * Update maintaining docs 2020-10-16 13:40:49 +02:00			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)`
Describe the release process 2016-08-28 17:34:22 +02:00
			`Creation of this tag triggers a new build:`

			* `Chart.js.zip` package is generated, containing dist files and examples
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 20:08:00 +01:00			* `dist/.js`, `types/.ts`, and `Chart.js.zip` are attached to the GitHub release (downloads)
Expand filename (#7893) * Fix double env * Properly expand name in attach step * Update maintaining docs 2020-10-16 13:40:49 +02:00			`* A new npm package is published on [npmjs](https://www.npmjs.com/package/chart.js)`
Describe the release process 2016-08-28 17:34:22 +02:00
			`Finally, [cdnjs](https://cdnjs.com/libraries/Chart.js) is automatically updated from the npm release.`

Patch release workflow (#8815) * Allow manual triggering of release drafter * Add instructions for patch release 2021-04-04 13:04:56 +02:00			`### 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)`

Describe the release process 2016-08-28 17:34:22 +02:00			`### Further Reading`

Expand filename (#7893) * Fix double env * Properly expand name in attach step * Update maintaining docs 2020-10-16 13:40:49 +02:00			`* [GitHub Action releases](https://github.com/chartjs/Chart.js/pull/7891)`
Finish removing bower (#7294) 2020-04-28 23:34:49 +02:00			`* [dist/* files](https://github.com/chartjs/Chart.js/issues/3033)`
Fix broken links in Maintaining.md 2016-09-13 05:21:40 +02:00			`* [cdnjs npm auto update](https://github.com/cdnjs/cdnjs/pull/8401)`