docutils/docs/dev/release.txt

   1 =============================
   2  Docutils_ Release Procedure
   3 =============================
   4
   5 :Authors: David Goodger; Lea Wiemann; open to all Docutils developers
   6 :Contact: docutils-develop@lists.sourceforge.net
   7 :Date: $Date$
   8 :Revision: $Revision$
   9 :Copyright: This document has been placed in the public domain.
  10
  11 .. _Docutils: http://docutils.sourceforge.io/
  12
  13 Releasing (post 2020)
  14 ---------------------
  15
  16 * Announce the upcoming release on docutils-develop list.
  17
  18   Consider **feature freeze** or/and **check-in freeze** .
  19
  20 * Update RELEASE-NOTES.txt add section ``Release <version>``.
  21
  22   Consult HISTORY.txt for important changes.
  23
  24 * Change HISTORY.txt title ``Changes Since <previous release>`` to ``Release <version>``.
  25
  26 * Set new version with ``sandbox/infrastructure/set_version.sh <version>``
  27
  28   Check what was changed with version control system by ``set_version.sh``
  29
  30   Run tests ::
  31
  32     export PYTHONWARNINGS=default
  33     python2 test/alltests.py
  34     python3 test/alltests.py
  35
  36   or use tox.
  37
  38   ``export PYTHONWARNINGS=default`` prints DeprecationWarnings in python3.
  39
  40 * Generate universal wheel and source-distribution::
  41
  42     python3 setup.py sdist
  43     python3 setup.py bdist_wheel --universal
  44
  45 * Upload universal wheel and source to test.pypi::
  46
  47     python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
  48
  49   Wait some minutes to test in virtualenv ::
  50
  51     python2 -m virtualenv py2.7 ; cd py2.7
  52     export PYTHONPATH= ; . bin/activate
  53
  54     python -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
  55
  56     cp -Lr ../docutils-code/docutils/test .
  57     python test/alltests.py
  58
  59     python -m pip uninstall docutils
  60     deactivate ; cd .. ; rm -r py2.7
  61
  62   Test in venv ::
  63
  64     python3 -m venv du3 ; cd du3
  65     export PYTHONPATH= ; . bin/activate
  66
  67     python -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
  68
  69     cp -Lr ../docutils-code/docutils/test .
  70     python test/alltests.py
  71
  72     python -m pip uninstall docutils
  73     deactivate ; cd .. ; rm -r du3
  74
  75 * Commit changes ... the changed version number.
  76
  77 * tag 0.## (Note: only directory docutils is copied)::
  78
  79     svn copy svn+ssh://grubert@svn.code.sf.net/p/docutils/code/trunk/docutils \
  80              svn+ssh://grubert@svn.code.sf.net/p/docutils/code/tags/docutils-0.## \
  81              -m "tagging release 0.##"
  82
  83 * Now upload to pypi::
  84
  85     python3 -m twine upload  dist/docutils-0.##*
  86
  87   and test::
  88
  89     python3 -m venv du3 ; cd du3
  90     export PYTHONPATH= ; . bin/activate
  91
  92     pip install --no-deps docutils
  93     cp -Lr ../docutils-code/docutils/test .
  94     python test/alltests.py
  95
  96     python2 -m virtualenv du2 ; cd du2
  97     export PYTHONPATH= ; . bin/activate
  98
  99     pip install --no-deps docutils
 100     cp -Lr ../docutils-code/docutils/test .
 101     python test/alltests.py
 102
 103 * Notify to docutils-developer and user.
 104
 105 * upload source and generated html to sf-htdocs/0.## ::
 106
 107     mkdir tmp1
 108     cd tmp1
 109     tar xzvf ../dist/docutils-0.##.tar.gz
 110     cd docutils-0.##/
 111     tools/buildhtml.py .
 112     find . -name \*.pyc -exec rm -v {} \;
 113     find . -name __pycache__ -exec rmdir -v {} \;
 114     rm -r docutils.egg-info
 115     rsync -e ssh -r -t ./ web.sourceforge.net:/home/project-web/docutils/htdocs/0.##
 116
 117 * Check web/index.txt for necessary corrections.
 118 * Run sandbox/infrastructure/docutils-update.local to update web-content.
 119 * Release to sourceforge.
 120
 121   - Upload tar.gz and 0.16 release notes to sourceforge.
 122   - Select docutils-0.16.tar.gz as default for all OS.
 123
 124 * set_version 0.#.#+1b.dev
 125 * test with py2 and py3
 126 * docutils/HISTORY.txt: add title "Changes Since 0.##"
 127 * run sandbox/infrastructure/docutils-update.local
 128
 129 \f
 130 ..
 131    Local Variables:
 132    mode: indented-text
 133    indent-tabs-mode: nil
 134    sentence-end-double-space: t
 135    fill-column: 70
 136    End: