]> git.jsancho.org Git - datasette-pytables.git/blobdiff - RELEASING.md
Fix html tests
[datasette-pytables.git] / RELEASING.md
index c4b8079054162174594836579f7dce4c6e0cc9fd..a6242f15bb87b83957958dc5c9fd238c2a02ad87 100644 (file)
@@ -7,6 +7,8 @@ Date: 2018-06-01
 
 ## Preliminaries
 
+* Update the version number at ``VERSION`` and ``ANNOUNCE.md``.
+
 * Make sure that ``RELEASE_NOTES.md`` and ``ANNOUNCE.md`` are up to
   date with the latest news in the release.
 
@@ -21,18 +23,18 @@ Date: 2018-06-01
 
 ## Tagging
 
-* Create a tag ``X.Y.Z`` from ``master``.  Use the next message:
+* Create a tag ``vX.Y.Z`` from ``master``.  Use the next message:
 
 ```
-    $ git tag -a X.Y.Z -m "Tagging version X.Y.Z"
+    $ git tag -a vX.Y.Z -m "Tagging version X.Y.Z"
 ```
 
-  Note: For release candidates, just add a rcN suffix to tag ("X.Y.ZrcN").
+  Note: For release candidates, just add a rcN suffix to tag ("vX.Y.ZrcN").
 
 * Or, alternatively, make a signed tag (requires gpg correctly configured):
 
 ```
-    $ git tag -s X.Y.Z -m "Tagging version X.Y.Z"
+    $ git tag -s vX.Y.Z -m "Tagging version X.Y.Z"
 ```
 
 * Push the tag to the Github repo:
@@ -42,6 +44,12 @@ Date: 2018-06-01
     $ git push --tags
 ```
 
+* Do the official release.  Go to:
+
+https://github.com/PyTables/datasette-pytables/releases/edit/vX.Y.Z
+
+and add the title for the release (vX.Y.Z) and the release notes there.
+
 
 ## Testing
 
@@ -62,6 +70,7 @@ Date: 2018-06-01
   $ git clone https://github.com/PyTables/datasette-pytables
   $ cd datasette-pytables
   $ python setup.py build
+  $ pytest
 ```
 
 * Make the tarball with the command:
@@ -84,7 +93,7 @@ Do a quick check that the tarball is sane.
 
 ## Announcing
 
-* Send an announcement to the python-announce, python-users and pydata
+* Send an announcement to the pytables-announce, pytables-users and pydata
   lists.  Use the ``ANNOUNCE.md`` file as skeleton (or possibly as
   the definitive version).
 
@@ -98,6 +107,8 @@ Do a quick check that the tarball is sane.
 
   #XXX version-specific blurb XXX#
 
+* Update ``VERSION`` file to X.Y.(Z+1)-dev
+
 * Commit your changes with:
 
 ```