aboutsummaryrefslogtreecommitdiff
path: root/node_modules/highlight.js/docs/release-process.rst
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/highlight.js/docs/release-process.rst')
-rw-r--r--node_modules/highlight.js/docs/release-process.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/node_modules/highlight.js/docs/release-process.rst b/node_modules/highlight.js/docs/release-process.rst
new file mode 100644
index 000000000..11cf28947
--- /dev/null
+++ b/node_modules/highlight.js/docs/release-process.rst
@@ -0,0 +1,20 @@
+Release process
+===============
+
+Note: this is intended for core committers.
+
+* Update CHANGES.md with everything interesting since the last update.
+
+* Update version numbers using the three-part x.y.z notation everywhere:
+
+ * The header in CHANGES.md (this is where the site looks for the latest version number)
+ * ``"version"`` attribute in package.json
+ * Two places in docs/conf.py (``version`` and ``release``)
+
+* Commit the version changes and tag the commit with the plain version number (no "v." or anything like that)
+
+* Push the commit and the tags to master (``git push && git push --tags``)
+
+Pushing the tag triggers the update process which can be monitored at http://highlightjs.org/api/release/
+
+When something didn't work *and* it's fixable in code (version numbers mismatch, last minute patches, etc), simply make another release incrementing the third (revision) part of the version number.