Author: pekka.klarck
Date: Mon Mar 23 09:29:30 2009
New Revision: 1489
Added:
wiki/Releasing.wiki
Log:
Documenting release procedure (issue 55).
Added: wiki/Releasing.wiki
==============================================================================
--- (empty file)
+++ wiki/Releasing.wiki Mon Mar 23 09:29:30 2009
@@ -0,0 +1,85 @@
+#summary Task list for creating releases
+
+<wiki:toc max_depth="2" />
+
+
+= Create Release Packages =
+
+== Tag Release and Create Source Packages ==
+
+Following shell commands create new tag and most of the needed packages:
+
+{{{
+version=x.y.z
+svn copy -m "Initial $version tag"
https://robotframework.googlecode.com/svn/trunk/ \
+ https://robotframework.googlecode.com/svn/tags/robotframework-$version
+svn checkout
https://robotframework.googlecode.com/svn/tags/robotframework-$version
+cd robotframework-$version
+./package.py version $version final
+tools/tool2html.py all
+doc/libraries/lib2html.py all
+doc/userguide/ug2html.py zip
+doc/quickstart/qs2html.py zip # Not needed if Quick Start hasn't been
updated
+svn stat # List changes and created packages
+svn commit -m "Finalizing $version"
+./package.py sdist keep
+}}}
+
+== Create Windows Installer ==
+
+Windows installer needs to be created separately on a Windows machine with
command:
+
+{{{
+./package.py wininst keep
+}}}
+
+== Upload Packages ==
+
+Upload these packages to Google Code with specified labels:
+
+ * Source distribution (_Featured_, _Type-Source_)
+ * Windows installer (_Featured_, _Type-Installer_, _OS-Windows_)
+ * User Guide (_Featured_, _Type-Docs_)
+ * Quick Start Guide (_Featured_, _Type-Docs_) if it has been updated
+
+Remember also to remove _Featured_ label from the previous release and
possibly add _Deprecated_ to older ones.
+
+
+= Update Wiki =
+
+It is easiest to edit *.wiki files locally and commit them. Some scripts
that help modifying wiki pages are available in `svn/wiki/tools`.
+
+== Release Notes ==
+
+Issue list can be added to release notes using `get_issues.py`. Common
usage is something like this:
+
+{{{
+tools/get_issues.py 2.1 >> ReleaseNotes21.wiki
+}}}
+
+== User Guide, Library and Tool Pages ==
+
+Library and tool pages as well as User Guide page needs to be updated
between releases. With major releases that can be done using
`release_update.py`, and with minor releases it is normally enough to use
`sed` e.g. like:
+
+{{{
+sed -i 's/2.1/2.1.1/g' *Tool.wiki
+}}}
+
+
+= Announce Release =
+
+== News to Project Front Page ==
+
+Must be edited using Administer tab and can thus be done only by project
owners.
+
+== Update PyPI ==
+
+http://pypi.python.org/pypi/robotframework/
+
+== Send Release Mail ==
+
+Both users and announcement [MailingLists mailing lists].
+
+== External Announcements ==
+
+Send news at least to http://opensourcetesting.org/.
\ No newline at end of file
