Updating release tools

Author: aaltat

BUILD.rst

@@ -1,19 +1,52 @@
 Instructions to create releases
 ===============================
 
+
+Preconditions
+-------------
+
+Operating system and Python requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Generating releases has only been tested on Linux, but it ought to work the
+same way also on OSX and other unixes. Creating releases is only supported
+with Python 3.6 or newer.
+
+The ``pip`` and ``invoke`` commands below are also expected to run on Python
+3.6+. Alternatively, it's possible to use the ``python3.6 -m pip`` approach
+to run these commands.
+
+Python dependencies
+~~~~~~~~~~~~~~~~~~~
+
+Many steps are automated using the generic `Invoke <http://pyinvoke.org>`_
+tool with a help by our `rellu <https://github.com/robotframework/rellu>`_
+utilities, but also other tools and modules are needed. A pre-condition is
+installing all these, and that's easiest done using `pip
+<http://pip-installer.org>`_ and the provided `<requirements.txt>`_ file::
+
+    pip install -r requirements.txt
+
+Using Invoke
+~~~~~~~~~~~~
+
+Invoke tasks are defined in the `<tasks.py>`_ file and they are executed from
+the command line like::
+
+    inv[oke] task [options]
+
+Creating release
+----------------
+
 1. Test that everything works::
 
+     python demoapp/server.py
      robot login_tests
 
-2. Regenerate log and report if needed using the command documented in wiki.
-   Same command as above.
-
-3. Move regenerated log and report to
-   https://bitbucket.org/robotframework/robotframework.bitbucket.org/src/master/WebDemo/
-   to make them visible online.
+2. Move regenerated log and report to docs::
 
-4. Generate a new download package::
+     inv move-docs
 
-     ./package.py
+5. If README.rst has changed, generate project documentation based on it::
 
-5. Upload the download package to https://bitbucket.org/robotframework/webdemo/downloads
+     inv project-docs

requirements.txt

@@ -0,0 +1,5 @@
+# Requirements needed when generating releases. See BUILD.rst for details.
+invoke >= 0.20
+rellu >= 0.6
+docutils >= 0.14
+robotframework >= 3.1.1

tasks.py

@@ -0,0 +1,36 @@
+from pathlib import Path
+import shutil
+
+from docutils.core import publish_cmdline
+from invoke import task
+from rellu.tasks import clean
+
+
+assert Path.cwd() == Path(__file__).parent
+
+@task
+def project_docs(ctx):
+    """Generate project documentation.
+
+    These docs are visible at http://robotframework.org/WebDemo/.
+    """
+    args = ['--stylesheet=style.css,extra.css',
+            '--link-stylesheet',
+            'README.rst',
+            'docs/index.html']
+    publish_cmdline(writer_name='html5', argv=args)
+    print(Path(args[-1]).absolute())
+
+@task
+def move_docs(ctx):
+    """Move report.html and log.html to docs
+
+    These docs are visible http://robotframework.org/WebDemo/.
+    """
+    log = Path('./log.html')
+    report = Path('./report.html')
+    dest = Path('.') / 'docs'
+    print(log.absolute())
+    shutil.copy(log.absolute(), str(dest))
+    print(report.absolute())
+    shutil.copy(report.absolute(), str(dest))