Skip to content

Commit 4654305

Browse files
committed
Add a release memo
1 parent 137d138 commit 4654305

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

RELEASE.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Things to do while releasing a new version
2+
==========================================
3+
4+
This file is a memo for the maintainer.
5+
6+
7+
0. Checks
8+
---------
9+
10+
* Check Copyright years in the LICENSE file
11+
* Check there will be no trash in the package (``npm pack``)
12+
* Check tests passes (``npx grunt`` and check the result in the browser)
13+
14+
15+
1. Release
16+
----------
17+
18+
* Update version number in ``package.json``
19+
* Edit / update changelog in ``README.md``
20+
* Commit / tag (``git commit -m vX.Y.Z && git tag vX.Y.Z && git push && git push --tags``)
21+
22+
23+
2. Publish NPM package
24+
-----------------------
25+
26+
* ``npm publish``
27+
28+
29+
3. Publish Github Release
30+
-------------------------
31+
32+
* Make a release on Github
33+
* Add changelog

0 commit comments

Comments
 (0)