Add release checklist to documentation.

galaxyproject · Feb 16, 2015 · 536b9c1 · 536b9c1
1 parent e8c1d45
commit 536b9c1
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 1 deletion.
diff --git a/docs/developing.rst b/docs/developing.rst
@@ -0,0 +1,27 @@
+==========
+Developing
+==========
+
+This section contains documentation for developers of planemo.
+
+Release Checklist
+-----------------
+
+This release checklist is based on the `Pocoo Release Management Workflow
+<http://www.pocoo.org/internal/release-management/>`_.
+
+ * Review ``git status`` for missing files.
+ * Verify the latest Travis CI builds pass.
+ * ``make lint && make test``
+ * Update version info in ``planemo/__init__.py`` (drop ``-dev`` suffix).
+ * Update release date and description in ``HISTORY.rst``.
+ * ``make docs`` and review changelog.
+ * ``git commit``
+ * ``python2.6 setup.py release bdist_egg sdist upload``
+ * ``python2.7 setup.py release bdist_egg sdist upload``
+ * Check PyPI release page for obvious errors (https://pypi.python.org/pypi/planemo)
+ * ``git tag <release>``
+ * Update version info in ``planemo/__init__.py`` (n+1-dev).
+ * ``git commit``
+ * ``git push origin``
+ * ``git push --tags origin``
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,10 +14,11 @@ Contents:
    readme
    installation
    configuration
+   appliance
    writing
    commands
    contributing
-   appliance
+   developing
    history
 
 Indices and tables