Skip to content

Commit

Permalink
chore(docs) update maintainer guide
Browse files Browse the repository at this point in the history
  • Loading branch information
joshgoebel committed Nov 18, 2020
1 parent c91fadd commit ee28327
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/maintainers-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Release process

Releases (minor) typically happen on a 6-week schedule.

For major/minor releases you'll be releasing from ``master``. For patch releases you'll be releasing from a stable branch, such as ``9-16-stable``. This allows ongoing development of new features to continue in isolation (in master) without those changes leaking into patch releases (which should focus only on fixing breaking changes).
For major/minor releases you'll be releasing from ``master``. For patch releases you'll be releasing from a stable branch, such as ``10-stable``. This allows ongoing development of new features to continue in isolation (in master) without those changes leaking into patch releases (which should focus only on fixing breaking changes).

The goal being that minor version series always get more stable over time and that patch releases do not add features.

* For patch releases: First switch to the associated stable branch (i.e., ``9-16-stable``)
* For patch releases: First switch to the associated stable branch (i.e., ``10-stable``)

* Update CHANGES.md with everything interesting since the last update.

Expand All @@ -30,12 +30,15 @@ The goal being that minor version series always get more stable over time and th
* ``version`` attribute in package.json
* ``version`` attribute in package-lock.json (run `npm install`)
* ``release`` variable in docs/conf.py
* All mentions of version number in the README

* Commit the version changes and tag the commit with the version number (``9.16.2``, no "v" prefix or anything like that)
* Commit the version changes and tag the commit with the version number (``10.4.0``, no "v" prefix or anything like that)

* For major/minor releases: Create a new ``[major]-[minor]-stable`` branch such as ``9-16-stable``
* For major/minor releases: Create (or push push) the ``[major]-stable`` branch such as ``10-stable``

* Push the commit and the tags (``git push && git push --tags``)
IE, the ``10-stable`` branch should always point to the latest stable release in the 10 series.

* Push the commit the tag (``git push && git push 10.4.0``)


Pushing the tag triggers the update process which can be monitored at http://highlightjs.org/api/release/
Expand Down

0 comments on commit ee28327

Please sign in to comment.