docutils/docs/dev/release.txt

   1 .. include:: ../header.txt
   2
   3 =============================
   4  Docutils_ Release Procedure
   5 =============================
   6
   7 :Authors: David Goodger; Lea Wiemann; open to all Docutils developers
   8 :Contact: docutils-develop@lists.sourceforge.net
   9 :Date: $Date$
  10 :Revision: $Revision$
  11 :Copyright: This document has been placed in the public domain.
  12
  13 .. _Docutils: https://docutils.sourceforge.io/
  14
  15 Steps to take and watch
  16 -----------------------
  17
  18 * Make a clean checkout of svn.code.sf.net/p/docutils/code/trunk/docutils
  19   to avoid having development files in the released packages.
  20
  21   Test, package and release this checkout.
  22
  23 * Announce the upcoming release on docutils-develop list.
  24
  25   Consider **feature freeze** or/and **check-in freeze** .
  26
  27 * Update RELEASE-NOTES.txt add section ``Release <version>``.
  28
  29   Consult HISTORY.txt for important changes.
  30
  31 * Change HISTORY.txt title ``Changes Since <previous release>`` to ``Release <version>``.
  32
  33 * Set new version (replace ``<version>`` with the new version indentifier
  34   and ``<docutils-repository-root>`` with the dir containing
  35   ``HISTORY.txt`` and ``RELEASE-NOTES.txt``)::
  36
  37       cd <docutils-repository-root>
  38       ../sandbox/infrastructure/set_version.sh <version>
  39
  40   Check what was changed by ``set_version.sh``.
  41
  42   Change acchordingly docutils/__init__.py ::
  43
  44     __version_info__ = VersionInfo(
  45         major=0,
  46         minor=21,
  47         micro=0,
  48         releaselevel='candidate',  # one of 'alpha', 'beta', 'candidate', 'final'
  49         serial=1,  # pre-release number (0 for final releases and snapshots)
  50         release=False  # True for official releases and pre-releases
  51         )
  52
  53
  54   Run tests ::
  55
  56     export PYTHONWARNINGS=default
  57     python3 test/alltests.py
  58
  59   or use tox.
  60   In case of errors, clearing ``docutils/__pycache__`` may help.
  61
  62   ``export PYTHONWARNINGS=default`` prints DeprecationWarnings in python3.
  63
  64 * Generate wheel and source-distribution::
  65
  66     python3 -m pip install build
  67     python3 -m build .
  68
  69 * check sdist for html-files in docutils.egg-info.
  70 * Upload wheel and source to test.pypi::
  71
  72     python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
  73
  74   Test in venv. NOTE use --pre for prereleases::
  75
  76     python3 -m venv du3 ; cd du3
  77     export PYTHONPATH= ; . bin/activate
  78
  79     python -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
  80
  81     cp -Lr ../docutils-code/docutils/test .
  82     python test/alltests.py
  83
  84     python -m pip uninstall docutils
  85     deactivate ; cd .. ; rm -r du3
  86
  87 * Commit changes ... the changed version number.
  88
  89 * tag #.# (Note: only directory docutils is copied)::
  90
  91     svn copy svn+ssh://grubert@svn.code.sf.net/p/docutils/code/trunk/docutils \
  92              svn+ssh://grubert@svn.code.sf.net/p/docutils/code/tags/docutils-#.# \
  93              -m "tagging release #.#"
  94
  95 * Update your source directory.
  96 * Rebuild wheel and source-distribution ::
  97
  98     python3 setup.py sdist
  99     python3 setup.py bdist_wheel
 100
 101 * Now upload to pypi::
 102
 103     python3 -m twine upload  dist/docutils-#.#*
 104
 105 * Remove previous package from local cache::
 106
 107     find .cache/pip/wheels -name docutils\*whl -exec rm -v -i {} \;
 108
 109 * and test::
 110
 111     python3 -m venv du3 ; cd du3
 112     export PYTHONPATH= ; . bin/activate
 113
 114     pip install --no-deps docutils
 115     cp -Lr ../docutils-code/docutils/test .
 116     python test/alltests.py
 117
 118     deactivate ; cd .. ; rm -r du3
 119
 120 * Notify to docutils-developer and user.
 121
 122 * upload source and generated html to sf-htdocs/#.# ::
 123
 124     mkdir tmp1
 125     cd tmp1
 126     tar xzvf ../dist/docutils-#.#.tar.gz
 127     cd docutils-#.#/
 128     python3 tools/buildhtml.py .
 129     find . -name \*.pyc -exec rm -v {} \;
 130     find . -name __pycache__ -exec rmdir -v {} \;
 131     rm -r docutils.egg-info
 132     rsync -e ssh -r -t ./ web.sourceforge.net:/home/project-web/docutils/htdocs/#.#
 133
 134 * Check web/index.txt for necessary corrections.
 135 * Run sandbox/infrastructure/docutils-update.local to update web-content.
 136 * Release to sourceforge.
 137
 138   - Upload docutils-#.#.tar.gz and release notes to sourceforge.
 139   - Select docutils-#.#.tar.gz as default for all OS.
 140
 141 * set_version #.{#+1}b.dev
 142 * test with py3
 143 * docutils/HISTORY.txt: add title "Changes Since #.#"
 144 * run sandbox/infrastructure/docutils-update.local
 145
 146 \f
 147 ..
 148    Local Variables:
 149    mode: indented-text
 150    indent-tabs-mode: nil
 151    sentence-end-double-space: t
 152    fill-column: 70
 153    End: