From: Simon Brunel <simonbrunel@users.noreply.github.com>
Date: Sun, 28 Aug 2016 15:34:22 +0000 (+0200)
Subject: Describe the release process
X-Git-Tag: v2.3.0-rc.1~1^2~16^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6d5638e4152bd16916309c2e625a489d7a8f5951;p=thirdparty%2FChart.js.git

Describe the release process
---

diff --git a/MAINTAINING.md b/MAINTAINING.md
new file mode 100644
index 000000000..c9a4c4db4
--- /dev/null
+++ b/MAINTAINING.md
@@ -0,0 +1,36 @@
+# 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. draft release notes on [GitHub](https://github.com/chartjs/Chart.js/releases/new) for the upcoming tag
+1. update `master` `package.json` version using [semver](http://semver.org/) semantic
+1. merge `master` into the `release` branch
+1. follow the build process on [Travis CI](https://travis-ci.org/chartjs/Chart.js)
+
+> **Note:** if `master` is merged in `release` with a `package.json` version that already exists, the tag
+creation fails and the release process is aborted.
+
+### Automated Tasks
+Merging into the `release` branch kicks off the automated release process:
+
+* build of the `dist/*.js` files
+* `bower.json` is generated from `package.json`
+* `dist/*.js` and `bower.json` are added to a detached branch
+* a tag is created from the `package.json` version
+* tag (with dist files) is pushed to GitHub
+
+Creation of this tag triggers a new build:
+
+* `Chart.js.zip` package is generated, containing dist files and examples
+* `dist/*.js` 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.
+
+### Further Reading
+
+* [Travis GitHub releases](/chartjs/Chart.js/pull/2555)
+* [Bower support and dist/* files](/chartjs/Chart.js/issues/3033)
+* [cdnjs npm auto update](/cdnjs/cdnjs/pull/8401)