Skip to content

Commit ee28327

Browse files
committed
chore(docs) update maintainer guide
1 parent c91fadd commit ee28327

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/maintainers-guide.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ Release process
1616

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

19-
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).
19+
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).
2020

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

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

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

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

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

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

38-
* Push the commit and the tags (``git push && git push --tags``)
39+
IE, the ``10-stable`` branch should always point to the latest stable release in the 10 series.
40+
41+
* Push the commit the tag (``git push && git push 10.4.0``)
3942

4043

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

0 commit comments

Comments
 (0)