sandbox/infrastructure/releasing-log.txt

   1 Releasing
   2 =========
   3
   4 :Contact: grubert@users.sourceforge.net, docutils-develop@users.sourceforge.net
   5 :Revision: $Revision$
   6 :Date: $Date$
   7 :Copyright: This document has been placed in the public domain.
   8
   9 Notes on what happend while releasing.
  10
  11 Problems
  12 ========
  13
  14 * If docutils is installed into virtual environment and
  15   the test directory is copied from development directory
  16   with ``cp -Lr ...``::
  17
  18        -L, --dereference
  19               always follow symbolic links in SOURCE
  20
  21   - finding ``HISTORY.txt`` in test_utils.py fails.
  22     Create a HISTORY.txt file to avoid.
  23
  24 Release 0.17 aftermath
  25 ======================
  26
  27 :2021-04-05: Fixed: on-ASCII characters in docutils/writers/latex2e/docutils.sty
  28
  29 :2021-04-04: Open: [readthedocs/recommonmark]
  30              AttributeError: 'Values' object has no attribute 'tab_width' (#220)
  31
  32              pinning to docutils 0.16 helped ... why ?
  33
  34 Release 0.17.1b1 (2021-04-09)
  35 =============================
  36
  37 * tox with 2.7 3.5, 3.6, 3.8, 3.9
  38
  39 * with LC_ALL=C and PYTHONWARNINGS=default
  40
  41   python3.6 and python3.10.0a ::
  42
  43     docutils/utils/smartquotes.py:639: DeprecationWarning: invalid escape sequence \[
  44         ch_classes = {'open': u'[(\[{]', # opening braces
  45     docutils/test/test_writers/test_manpage.py:62: DeprecationWarning: invalid escape sequence \-
  46     ... several of the same
  47
  48 * recommonmark tests::
  49
  50     python3.6 -m pip install --user recommonmark
  51     # 0.7.1
  52
  53     python3.6 test/alltests.py
  54     FAILED (failures=17, errors=17, skipped=1)
  55
  56     input:
  57     b'\nExternal hyperlink [target]s:\n\n[target]: http://www.python.org/\n'
  58     -: expected
  59     +: output
  60       <document source="test data">
  61           <paragraph>
  62               External hyperlink
  63     -         <reference name="target" refuri="http://www.python.org/">
  64     ?                   --------------
  65     +         <reference refuri="http://www.python.org/">
  66                   target
  67               s:
  68
  69   only works with recommonmark 0.4
  70
  71 * Generate universal wheel and source-distribution with py38.
  72 * Upload universal wheel and source to test.pypi.
  73 * Test in python3.8 venv
  74
  75   Fails.
  76
  77   Inside virtualenv ::
  78
  79     >>> import docutils.parsers.recommonmark_wrapper as rw
  80     >>> dir(rw)
  81     ['Parser', '__builtins__', '__cached__', '__doc__', '__file__',
  82      '__loader__', '__name__', '__package__', '__spec__',
  83      '_recommonmarkParser', 'docutils', 'nodes', 'with_recommonmark']
  84
  85   In development directory ::
  86
  87     >>> import docutils.parsers.recommonmark_wrapper as rw
  88     >>> dir(rw)
  89     ['CommonMarkParser', 'Component', 'Parser', '__builtins__',
  90      '__cached__', '__doc__', '__file__', '__loader__',
  91      '__name__', '__package__', '__spec__', 'docutils', 'nodes']
  92
  93   Depending on recommonmark being installed in the running python
  94   version or not ``CommonMarkParser`` is a class or None.
  95
  96 * Rebuild the wheel after running tox (this cleans caches).
  97   Cannot be uploaded to testpypi because it is the same name.
  98
  99   Install the whl from dist-directory into py38 venv.
 100   Ok.
 101
 102 * New version 0.17.1b1.dev because pypi does not allow changing uploads.
 103 * Run tox and python3.10 test.
 104 * Commit new version number
 105 * build sdist and universal wheel with py39.
 106 * Install wheel from dist into venv py39.
 107
 108   Test passes (embedding fails because images are missing).
 109
 110 * Upload universal wheel and source to test.pypi.
 111 * Install into py39 venv : This time install the --pre release
 112   tests pass.
 113
 114 * upload to pypi.
 115 * test in py39 venv. Passed
 116 * test in py39 venv with LC_ALL=C. Passed
 117 * test in venv with recommonmark==0.4: fails . requires module html.
 118
 119 * notify docutils-develop and user and sphinx.
 120 * New version 0.17.1b2.dev
 121
 122 Release 0.17 (2021-04-03 ...)
 123 =============================
 124
 125 * tox with 2.7 3.8, 3.9
 126
 127   3.10a6 misses _ctypes.
 128
 129 * copy more things from HISTORY to RELEASE-NOTES
 130
 131 * ``set_version.sh 0.17``
 132
 133 * Run tests manually and via tox:
 134
 135   ======== ======
 136    pyvers   time
 137   ======== ======
 138      2.7    7.3
 139      3.8    6.5
 140      3.9    6.5
 141      3.10   7.2
 142   ======== ======
 143
 144 * Generate universal wheel and source-distribution.
 145 * Upload universal wheel and source to test.pypi.
 146   Wait some minutes to test in python2 virtualenv.
 147
 148   Test in python3.10 venv.
 149
 150   Stylesheet paths are different and image embedding fails
 151   because images are not found.
 152
 153   After copying ``docs/user/rst/images`` from docutils into the
 154   venv-directory/docs/user/rst/images image embedding works.
 155
 156 * Commit changes to version control system.
 157 * tag 0.17 (Note: only directory docutils is copied)::
 158
 159     svn copy svn+ssh://grubert@svn.code.sf.net/p/docutils/code/trunk/docutils \
 160              svn+ssh://grubert@svn.code.sf.net/p/docutils/code/tags/docutils-0.17 \
 161              -m "tagging release 0.17"
 162
 163 * Generate universal wheel and source-distribution.
 164   Do it again and check for differences: svn-numbers and sha-fingerprints
 165
 166 * Now upload to pypi (the newly created s- and bdist).
 167 * ... and test in venv and virtualenv.
 168 * Notify to docutils-developer and user.
 169 * Upload source and html to sf-htdocs/0.17
 170
 171 * Check web/index.txt for necessary corrections: nothing to do.
 172
 173 * Run sandbox/infrastructure/docutils-update.local to update web-content.
 174 * Release to sourceforge.
 175
 176   - Upload tar.gz and 0.17 release notes to sourceforge.
 177   - Select docutils-0.17.tar.gz as default for all OS.
 178
 179 * set_version 0.18b.dev
 180 * test with py2 and py3
 181 * docutils/HISTORY.txt: add title "Changes Since 0.17"
 182
 183 * run sandbox/infrastructure/docutils-update.local
 184
 185 BetaRelease 0.17b1 (2021-02-10) to test.pypi
 186 ============================================
 187
 188 * tox with 2.7 3.8 and 3.9 ::
 189
 190     functional/expected/standalone_rst_html5.html
 191
 192     -<dl class="footnote brackets">
 193     ...
 194     -<dd><p>Requires support for attributes to inline
 195     -roles to make sense.</p>
 196     -</dd>
 197     -</dl>
 198
 199   seams to be a moved chunk in test input but not in expected
 200
 201 * Version numbering
 202
 203   ``python3 setup.py clean`` tells ::
 204
 205     setuptools/dist.py:473: UserWarning: Normalizing '0.17b.dev' to '0.17b0.dev0'.
 206
 207   Acchording to https://www.python.org/dev/peps/pep-0440/#pre-releases
 208
 209   set_version 0.17b1
 210
 211 * test ::
 212
 213     export PYTHONPATH=
 214     export PYTHONWARNINGS=default
 215     python2 test/alltests.py
 216
 217     Ran 1454 tests
 218     OK (skipped=3)
 219
 220     python3 test/alltests.py
 221     Ran 1442 tests
 222     OK (skipped=5)
 223
 224   python has some ResourceWarning::
 225
 226     docutils/parsers/rst/directives/images.py:145: ResourceWarning:
 227       unclosed file <_io.BufferedReader name=b'../docs/user/rst/images/title.png'>
 228       del img
 229
 230     docutils/writers/html4css1/__init__.py:578: ResourceWarning:
 231       unclosed file <_io.BufferedReader name=b'../docs/user/rst/images/biohazard.png'>
 232       del img
 233
 234 * Upload universal wheel and source to test.pypi::
 235
 236     python3 setup.py sdist
 237     python3 setup.py bdist_wheel --universal
 238     python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 239
 240   Wait some minutes to test in virtualenv ::
 241
 242     python2 -m virtualenv du2 ; cd du2
 243     export PYTHONPATH= ; . bin/activate
 244
 245     python -m pip install --index-url https://test.pypi.org/simple/ --no-deps --pre docutils
 246     # Successfully installed docutils-0.17b1
 247
 248     cp -r ~/projects/docutils-code/docutils/test .
 249     # copy docs too for inlined images to be found
 250     python2 test/alltests.py
 251     # IGNORE stylesheet path differences ?
 252
 253   Test in venv ::
 254
 255     python3 -m venv du3 ; cd du3
 256     export PYTHONPATH= ; . bin/activate
 257
 258     python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps --pre docutils
 259     # Successfully installed docutils-0.17b1
 260
 261     cp -r ~/projects/docutils-code/docutils/test .
 262     cp -r ~/projects/docutils-code/docutils/docs .
 263     python test/alltests.py
 264     # Python 3.8.5 Linux 5.4.0
 265     # IGNORE stylesheet path differences ?
 266
 267 * commit 0.17b1 to code.sf
 268
 269 * Now upload to pypi::
 270
 271     python3 -m twine upload  dist/docutils-0.17b1*
 272
 273 * and test::
 274
 275     python3 -m venv du3 ; cd du3
 276     export PYTHONPATH= ; . bin/activate
 277
 278     pip install --no-deps --pre docutils
 279     # 0.17b1
 280     cp -r ~/projects/docutils-code/docutils/test .
 281     cp -r ~/projects/docutils-code/docutils/docs .
 282     python test/alltests.py
 283     # css paths fail
 284
 285 * Notify to docutils-developer and user.
 286
 287 * ON RELEASE then: tag 0.16 (Note: only directory docutils is copied)::
 288
 289     svn copy svn+ssh://grubert@svn.code.sf.net/p/docutils/code/trunk/docutils \
 290              svn+ssh://grubert@svn.code.sf.net/p/docutils/code/tags/docutils-0.16 \
 291              -m "tagging release 0.16"
 292
 293 * run sandbox/infrastructure/docutils-update.local
 294
 295 * set version 0.17b2.dev
 296 * test with tox: py27 and py38 39
 297 * commit to code.sf
 298 * run sandbox/infrastructure/docutils-update.local
 299
 300 .. note:: final release has some extra steps
 301
 302 Release 0.16 (2020-01-12)
 303 =========================
 304
 305 Set version 0.16
 306
 307 test ::
 308
 309   export PYTHONWARNINGS=default
 310   python2 test/alltests.py
 311   python3 test/alltests.py
 312
 313 Upload universal wheel and source to test.pypi::
 314
 315   python3 setup.py sdist
 316   python3 setup.py bdist_wheel --universal
 317   python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 318
 319 Wait some minutes to test in virtualenv ::
 320
 321   python2 -m virtualenv du2 ; cd du2
 322   export PYTHONPATH= ; . bin/activate
 323
 324   python -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
 325   # Successfully installed docutils-0.16
 326
 327   cp -r ~/projects/docutils-code/docutils/test .
 328   python2 test/alltests.py
 329   # IGNORE stylesheet path differences ?
 330
 331   python -m pip uninstall docutils
 332   deactivate ; cd .. ; rm -rf du2
 333
 334 Test in venv ::
 335
 336   python3 -m venv du3 ; cd du3
 337   export PYTHONPATH= ; . bin/activate
 338
 339   python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
 340   # Successfully installed docutils-0.16
 341
 342   cp -r ~/projects/docutils-code/docutils/test .
 343   python test/alltests.py
 344   # IGNORE stylesheet path differences ?
 345   # FAIL: test_find_file_in_dirs (test_utils.HelperFunctionTests)
 346   # FAIL: test_rst/ interpreted directives/code ...
 347   #  classes="keyword" is "name builtin" in 3.8.0b3 on Darwin 15.6.0
 348
 349 Now upload to pypi::
 350
 351   python3 -m twine upload  dist/docutils-0.16*
 352
 353 and test::
 354
 355   python3 -m venv du3 ; cd du3
 356   export PYTHONPATH= ; . bin/activate
 357
 358   pip install --no-deps docutils
 359   # 0.16
 360   cp -r ~/projects/docutils-code/docutils/test .
 361   python test/alltests.py
 362   # css paths fail
 363
 364   python2 -m virtualenv du2 ; cd du2
 365   export PYTHONPATH= ; . bin/activate
 366
 367   pip install --no-deps docutils
 368   # 0.16
 369   cp -r ~/projects/docutils-code/docutils/test .
 370   python test/alltests.py
 371   # css paths fail
 372
 373 Notify to docutils-developer and user.
 374
 375 * tag 0.16 (Note: only directory docutils is copied)::
 376
 377     svn copy svn+ssh://grubert@svn.code.sf.net/p/docutils/code/trunk/docutils \
 378              svn+ssh://grubert@svn.code.sf.net/p/docutils/code/tags/docutils-0.16 \
 379              -m "tagging release 0.16"
 380
 381 * upload doc/0.16 ::
 382
 383     mkdir tmp1
 384     cd tmp1
 385     tar xzvf ../dist/docutils-0.16.tar.gz
 386     cd docutils-0.16/
 387     tools/buildhtml.py .
 388     find . -name \*.pyc -exec rm {} \;
 389     rm -rf docutils.egg-info
 390     rsync -e ssh -r -t ./ web.sourceforge.net:/home/project-web/docutils/htdocs/0.16
 391
 392 * change web index.txt
 393 * run sandbox/infrastructure/docutils-update.local
 394
 395 * set version 0.17b.dev
 396 * test with py2 and py3
 397 * run sandbox/infrastructure/docutils-update.local
 398
 399 * docutils/HISTORY.txt: change title "Changes since 0.15" to "Release 0.16"
 400   add "Changes since 0.16"
 401 * docutils/RELEASE-NOTES.txt change title "Release 0.16b ..." to Release 0.16 ..."
 402
 403 * Release to sourceforge.
 404
 405   - Remove test/outputs from tar.gz.
 406   - Upload tar.gz and 0.16 release notes to sourceforge.
 407   - Select docutils-0.16.tar.gz as default for all OS.
 408
 409 Release 0.16rc1
 410 ---------------
 411
 412 Set version 0.16rc1
 413
 414 test ::
 415
 416   export PYTHONWARNINGS=default
 417   python2 test/alltests.py
 418   python3 test/alltests.py
 419
 420 Fix: DeprecationWarning: Please use assertEqual in test_nodes.
 421
 422 Upload universal wheel and source to test.pypi::
 423
 424   python3 setup.py sdist
 425   python3 setup.py bdist_wheel --universal
 426   python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 427
 428 Wait some minutes to test in virtualenv ::
 429
 430   python2 -m virtualenv du2 ; cd du2
 431   export PYTHONPATH= ; . bin/activate
 432
 433   python -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
 434   # Successfully installed docutils-0.15.2
 435   python -m pip uninstall docutils
 436   python -m pip install --index-url https://test.pypi.org/simple/ --no-deps --pre docutils
 437   # Successfully installed docutils-0.16Crc1
 438
 439   cp -r ~/projects/docutils-code/docutils/test .
 440   python2 test/alltests.py
 441   # IGNORE stylesheet path differences ?
 442
 443   # -<link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" />
 444   # -<link rel="stylesheet" href="../input/data/math.css" type="text/css" />
 445   # +<link rel="stylesheet" href="../../html4css1.css" type="text/css" />
 446   # +<link rel="stylesheet" href="../../math.css" type="text/css" />
 447
 448   deactivate ; cd .. ; rm -rf du2
 449
 450 Test in venv ::
 451
 452   python3 -m venv du3 ; cd du3
 453   export PYTHONPATH= ; . bin/activate
 454
 455   python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
 456   # Successfully installed docutils-0.15.2
 457   python -m pip uninstall docutils
 458   python -m pip install --index-url https://test.pypi.org/simple/ --no-deps --pre docutils
 459   # Successfully installed docutils-0.16b0.dev0
 460   cp -r ~/projects/docutils-code/docutils/test .
 461   python test/alltests.py
 462
 463 Seven CSS-path failures ... ignored for now::
 464
 465   deactivate ; cd .. ; rm -rf du3
 466
 467 Now upload to pypi::
 468
 469   python3 -m twine upload  dist/docutils-0.16rc1*
 470
 471 and test::
 472
 473   python3 -m venv du3 ; cd du3
 474   export PYTHONPATH= ; . bin/activate
 475
 476   pip install --no-deps --pre docutils
 477   # 0.16rc1
 478   cp -r ~/projects/docutils-code/docutils/test .
 479   python test/alltests.py
 480   # css paths fail
 481
 482   python2 -m virtualenv du2 ; cd du2
 483   export PYTHONPATH= ; . bin/activate
 484
 485   pip install --no-deps --pre docutils
 486   # 0.16rc1
 487   cp -r ~/projects/docutils-code/docutils/test .
 488   python test/alltests.py
 489   # css paths fail
 490
 491 Notify to docutils-developer and user.
 492
 493 Release 0.15 (2019-07-24)
 494 =========================
 495
 496 branches/rel-0.15
 497
 498 CAUTION (2019-07-22)
 499 ====================
 500
 501   While releasing 0.15 ::
 502
 503     python3 setup.py sdist bdist_wheel
 504     python2 setup.py bdist_wheel
 505
 506   This will result in the py2 wheel being identical to the py3 one.
 507
 508   The name ``docutils-0.15-py2-none-any.whl`` cannot be used twice on pypi,
 509   build the py2-wheel and rename it ``docutils-0.15.post1-py2-none-any.whl``.
 510   (No code was changed therefore only filename change.)
 511
 512   Name it ``docutils-0.15-post1-py2-none-any.whl`` then the version in the filename
 513   corresponds to the directory names in the wheel file.
 514
 515   Maybe change the the version number in setup.py ?
 516
 517 Release 0.15.2 (2019-07-30)
 518 ===========================
 519
 520 Bump the version number to ease tool live.
 521
 522 Bump version ::
 523
 524   set_version 0.15.2
 525   python2 test/alltests.py
 526   python3 setup.py test3/alltests.py
 527   # visual inspection
 528   svn di | grep '^[+-]' | less -p '0.15.[12]'
 529   svn ci
 530
 531 Build py2 release upload to test.pypi ::
 532
 533   mkdir py2 ; cd py2
 534   svn export svn+ssh://grubert@svn.code.sf.net/p/docutils/code/branches/rel-0.15/docutils
 535   cd docutils
 536   python2 setup.py sdist bdist_wheel
 537   python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/docutils-0.15.2-py2-none-any.whl
 538
 539 Test in virtualenv ::
 540
 541   virtualenv du2 ; cd du2
 542   export PYTHONPATH= ; . bin/activate
 543
 544   python -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
 545   cp -r ~/projects/docutils-rel-0.15/docutils/py2/docutils/test .
 546   python2 test/alltests.py
 547   # IGNORE stylesheet path differences
 548
 549   deactivate ; cd .. ; rm -rf du2
 550
 551 release to pypi from the exported source directory   ::
 552
 553   python3 -m twine upload  dist/docutils-0.15.2*
 554
 555 Test in new virtualenv ::
 556
 557   virtualenv du2 ; cd du2
 558   export PYTHONPATH= ; . bin/activate
 559
 560   pip install docutils
 561   # Successfully installed docutils-0.15.2
 562
 563   cp -r ~/projects/docutils-rel-0.15/docutils/py2/docutils/test .
 564   python2 test/alltests.py
 565   # IGNORE stylesheet path differences
 566
 567   deactivate ; cd .. ; rm -rf du2
 568
 569 Build py3 release upload to test.pypi.
 570 In the export/docutils ::
 571
 572   # py3 and source
 573   python3 setup.py bdist_wheel
 574   python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/docutils-0.15.2-py3-none-any.whl
 575
 576 Test in virtualenv ::
 577
 578   python3 -m venv du3 ; cd du3
 579   export PYTHONPATH= ; . bin/activate
 580
 581   python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
 582
 583 BUG install 0.15 source. Check test.pypi web interface ... py3-wheel is there.
 584 Retry::
 585
 586   # Successfully installed docutils-0.15.2
 587   cp -r ~/projects/docutils-rel-0.15/docutils/py2/docutils/test3 .
 588   python test3/alltests.py
 589   # IGNORE upper directory Failure
 590
 591   deactivate ; cd .. ; rm -rf du3
 592
 593 release to pypi from the exported source directory   ::
 594
 595   python3 -m twine upload  dist/docutils-0.15.2-py3*
 596
 597 Wait for wheel to appear on pypi.org.
 598
 599 Test in virtualenv ::
 600
 601   python3 -m venv du3 ; cd du3
 602   export PYTHONPATH= ; . bin/activate
 603
 604   pip install docutils
 605   # Successfully installed docutils-0.15.2
 606
 607   cp -r ~/projects/docutils-rel-0.15/docutils/py2/docutils/test3 .
 608   python test3/alltests.py
 609   # IGNORE upper directory Failure
 610
 611   deactivate ; cd .. ; rm -rf du3
 612
 613 FINE 0.15.2
 614
 615 Release 0.15.1 (2019-07-24)
 616 ===========================
 617
 618 Bug fix release for python2 only.
 619
 620 * set version 0.15.1
 621 * ``python2 setup.py sdist bdist_wheel``
 622 * ``python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/docutils-0.15.1-py2-none-any.whl ``
 623 * in a new virtualenv::
 624
 625     python -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
 626
 627   and then test/alltests.py
 628
 629 * ``python3 -m twine upload  dist/docutils-0.15.1*``
 630
 631   upload py2-wheel and source.
 632
 633 * in a new virtualenv::
 634
 635     python -m pip install docutils
 636
 637   and then test/alltests.py
 638
 639 * (2019-07-25) replace source by -post1
 640
 641   Name it ``docutils-0.15.1-post1.tar.gz`` to make sure
 642
 643   * It is unchanged library code: *post1*
 644   * the version is still 0.15.1: therefore separate with ``-``
 645
 646   * run the tests somewhere, fix and commit.
 647     Then::
 648
 649       svn export svn+ssh://@svn.code.sf.net/p/docutils/code/branches/rel-0.15/docutils d
 650       cd d
 651       python2 setup.py sdist
 652
 653   * check ``tar tzf dist/docutils-0.15.1.tar.gz`` for remaining files.
 654     Then::
 655
 656       mv dist/docutils-0.15.1.tar.gz dist/docutils-0.15.1-post1.tar.gz
 657       python -m twine upload dist/docutils-0.15.1-post1.tar.gz
 658
 659   * Build a venv (python3), install docutils, copy test3 from development
 660     directory and run the test.
 661
 662     As there is no 0.15.1 wheel for python3 this will be the source package.
 663
 664 Release 0.15
 665 ============
 666
 667 svn revision: 8258 - start of release
 668
 669 * test on linux 2.7 3.7 : passed
 670 * test on macosx python2.6:
 671
 672   - 7 failures due to different error messages. see below
 673   - 4 errors: python2.6 sys.version_info is a tuple no dictionary
 674     FIXED: revision 8260
 675
 676 * test on macosx 2.7 3.4 3.6 3.7 : passed
 677 * change version to : 0.15rc1.dev
 678
 679   - run tests: python 2.7 and 3.7
 680
 681 * extract changes from HISTORY.txt to RELEASE-NOTES.txt
 682 * rename headings in HISTORY.txt and RELEASE-NOTES.txt
 683 * run release.sh stage 2: do a clean checkout and packing
 684 * run local test with python 2.6 2.7 3.4 3.6 3.7
 685 * upload to sourceforge.net. Keep 0.15 as latest, stable.
 686 * Fix: README.txt version number BY HAND
 687 * pypi :
 688
 689   - docutils is registered
 690   - check setup.py : add classifier 'Programming Language :: Python :: 3.7'
 691   - Login to pypi (see https://packaging.python.org/tutorials/packaging-projects/)
 692
 693     - python3 -m pip install --user --upgrade setuptools wheel
 694
 695       (warns about not being in PATH. symlink into my/bin)
 696     - python3 setup.py sdist bdist_wheel ::
 697
 698         /Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/distutils/dist.py:274: UserWarning: Unknown distribution option: 'python_requires'
 699           warnings.warn(msg)
 700
 701         error: invalid command 'bdist_wheel'
 702
 703     - add import setuptools to setup.py
 704     - python3 setup.py sdist bdist_wheel
 705     - python2 setup.py bdist_wheel
 706     - python3 -m pip install --user --upgrade twine
 707     - twine upload dist/*
 708
 709   check on pypi: 0.15 is there.
 710
 711 * update website docs
 712
 713   - in directory web edit index.txt
 714   - in sandbox/infrastructure run ./docutils-update.local
 715
 716 * set version of repository to 0.16b.dev
 717
 718 Release 0.14
 719 ============
 720
 721 svn revision: 8145 - start of release - 0.15.0 beta
 722
 723 Prerelease 0.14a0
 724 =================
 725
 726 svn revision: 8082 Prerelease 0.14a0
 727 svn revision: 8078 Prerelease 0.14.0a
 728
 729 * merge changes from HISTORY.txt to RELEASE-NOTES.txt
 730 * extract release number description setting from release.sh
 731 * rename headings in HISTORY.txt and RELEASE-NOTES.txt
 732 * run release.sh stage 2: do a clean checkout and packing
 733 * run local test with python2.7
 734 * upload to sourceforge.net. Keep 0.13 as latest, stable.
 735 * reister on to pypi and upload tgz
 736 * pypi: unset hide old releases
 737
 738
 739 Release 0.13
 740 ============
 741
 742 svn revision: 7980
 743
 744 Tests
 745 -----
 746
 747 Tests are run from svn checkout, only few from install.
 748
 749 * windows7 python 2.7.5: OK
 750
 751 * windows7 python 3.4.1: as in previous release
 752
 753   * test.css path error (filed #256)
 754   * test_parsers\test_rst\test_directives\test_include.py::
 755
 756 * macosx 10.10 python 2.7.10: OK
 757 * macosx 10.10 python 3.3.2: OK
 758 * macosx 10.10 python 3.4.1: OK
 759
 760 * ubuntu 12.04 python 2.7.3: OK
 761 * ubuntu 12.04 python 3.2.3: OK
 762
 763 * testing tarball 0.13.1 (build sdist) ::
 764
 765     +++ functional/output/standalone_rst_html5.html
 766     @@ -7,9 +7,9 @@
 767      <meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description" xml:lang="en" />
 768     -<link rel="stylesheet" href="../input/data/minimal.css" type="text/css" />
 769     -<link rel="stylesheet" href="../input/data/plain.css" type="text/css" />
 770     -<link rel="stylesheet" href="../input/data/math.css" type="text/css" />
 771     +<link rel="stylesheet" href="../../minimal.css" type="text/css" />
 772     +<link rel="stylesheet" href="../../plain.css" type="text/css" />
 773     +<link rel="stylesheet" href="../../math.css" type="text/css" />
 774      </head>
 775
 776   this is because ``test/functional/input/data/minimal.css`` is a symlink to
 777   ``../../../../docutils/writers/html5_polyglot/minimal.css`` and release_test.sh
 778   removes directory docutils to ensure the test uses the installed docutils
 779   not the unzipped.
 780
 781   FIX: remove docutils/__init__.py
 782
 783 Release 0.12
 784 ============
 785
 786 svn revision: 7749
 787
 788 Tests
 789 -----
 790
 791 Tests are run from svn checkout, only few from install.
 792
 793 Python3 tests are run ::
 794
 795   rm -rf build test3
 796   python3 setup.py build
 797   PYTHONPATH=build/lib python3 test3/alltests.py
 798
 799 * ubuntu 8.04: python 2.4.5, 2.5.2, 2.6.7, 2.7.2 OK
 800
 801   python 2.6.4rc1 6 failure due to change in error message: no such file ...
 802
 803   python 3.2.3 OK
 804
 805 * macosx 10.6.8: python 2.5.4, 2.7.3
 806
 807   python 2.6.1 6 failure due to change in error message: no such file ...
 808
 809   python 3.2, 3.4.1 OK
 810
 811 * ubuntu 14.04: pyton 2.7.6,  python 3.4.0 OK
 812
 813 * windows7: python 2.7.5
 814
 815   Error (filed #256): test_writers/test_html4css1_template.py::
 816
 817       stylesheet = """\
 818     - <link rel="stylesheet" href="/test.css" type="text/css" />"""
 819     + <link rel="stylesheet" href="C:/test.css" type="text/css" />"""
 820     ?                              ++
 821
 822   python 3.4.1
 823
 824   * test.css path error (filed #256)
 825   * test_parsers\test_rst\test_directives\test_include.py::
 826
 827       b'Encoding:\n\n.. include:: test_parsers/test_rst/test_directives/utf-16.csv\n   :encoding: utf-16\n'
 828         File "test3\alltests.py", line 40, in write
 829           string = string.encode('raw_unicode_escape').decode('ascii')
 830       UnicodeDecodeError: 'ascii' codec can't decode byte 0xb0 in position 994: ordinal not in range(128)
 831
 832    fiddling with alltests.py (uncommitted) ::
 833
 834       <system_message level="4" line="1" source="test data" type="SEVERE">
 835         <paragraph>
 836             Problem with "raw" directive:
 837             UnicodeDecodeError: \'utf-16-be\' codec can\'t decode bytes in position 90-91: illegal encoding
 838         <literal_block xml:space="preserve">
 839             .. raw:: html
 840                :file: test_parsers/test_rst/test_directives/utf-16.csv
 841                :encoding: utf-16''' != '''\
 842
 843
 844
 845 Release 0.11
 846 ============
 847
 848 Summary
 849 -------
 850
 851 ``sandbox/infrastructure/release.sh`` tries running ``test/alltests.py`` after
 852 installing the new release, this fails because
 853
 854 * tests depends on e.g. ``../docs/user/rst/images/title.png`` or ``../HISTORY.txt``,
 855   but thess are neither in the test directory tree nor in the installed software.
 856
 857 * there is a lot of code trying to handle varying installation targets ``/usr/lib``
 858   ``/usr/local/lib` and not yet ``/usr/lib/pymodules``.
 859
 860 Change testing to:
 861
 862 1. build and install
 863 2. extract docutils-<release>.tar.gz into tmp
 864 3. remove docutils/docutils directory, just to make shure it is not used.
 865 4. run test/alltest.py in this directory, so all files are where they are
 866    while development.
 867
 868 Following failure becuase docutils-library directory was removed, therefore
 869 docutils/writers/html4css1/html4css1.css is not found::
 870
 871   ======================================================================
 872   FAIL: test_custom_stylesheet_dir (test_writers.test_html4css1_misc.SettingsTestCase)
 873   ----------------------------------------------------------------------
 874   Traceback (most recent call last):
 875     File "/... 0.11/test/test_writers/test_html4css1_misc.py", line 81, in test_custom_stylesheet_dir
 876       self.assertIn('docutils/writers/html4css1/html4css1.css', styles)
 877     File "/... 0.11/test/DocutilsTestSupport.py", line 138, in assertIn
 878       msg or '%s not in %s' % _format_str(a, b))
 879   AssertionError: 'docutils/writers/html4css1/html4css1.css' not in u'''\
 880   <link rel="stylesheet" href="html4css1.css" type="text/css" />
 881   <link rel="stylesheet" href="data/ham.css" type="text/css" />
 882   '''
 883
 884
 885 Tests
 886 -----
 887
 888 * ubuntu 8.04 2.4.5, 2.5.2, 2.6.7, 2.7.2 OK
 889
 890   python 2.6.4rc1 6 failure due to change in error message: no such file ...
 891
 892   Python 3.2.3 : OK (roman.py left over from last release)
 893
 894 * macosx 10.6.8: python 2.5.4, 2.7.3
 895
 896   python 2.6.1 6 failure due to change in error message: no such file ...
 897
 898   python 3.2: roman.py for py3 required.
 899
 900 Release.sh
 901 ----------
 902
 903 release.sh does not work on MacOSX.
 904
 905 installation on ubuntu 10.04 breaks test script::
 906
 907   Working directory: /usr/local/lib/python2.6/site-packages/docutils-test
 908   Docutils package: /usr/local/lib/python2.6/dist-packages/docutils
 909
 910   ======================================================================
 911   FAIL: test_find_file_in_dirs (test_utils.HelperFunctionsTests)
 912   ----------------------------------------------------------------------
 913   Traceback (most recent call last):
 914     File "/usr/local/lib/python2.6/site-packages/docutils-test/test_utils.py", line 295, in test_find_file_in_dirs
 915       '../HISTORY.txt')
 916   AssertionError: 'HISTORY.txt' != '../HISTORY.txt'
 917
 918 Stopping for now.
 919
 920
 921
 922 Release 0.10
 923 ============
 924
 925 * same failures for some python2.6 versions ::
 926
 927               Problems with "raw" directive path:
 928        -      InputError: [Errno 2] No such file or directory: 'non-existent.file'.
 929        +      InputError: (2, 'No such file or directory').
 930
 931 * testing release tarball ::
 932
 933     ======================================================================
 934     FAIL: test_dependencies (__main__.RecordDependenciesTests)
 935     ----------------------------------------------------------------------
 936     Traceback (most recent call last):
 937       File "docutils-test/test_dependencies.py", line 61, in test_dependencies
 938         self.assertEqual(record, expected)
 939     AssertionError: [u'data/include.txt', u'data/raw.txt'] != [u'../docs/user/rst/images/title.png',
 940     u'data/include.txt', u'data/raw.txt']
 941
 942     ...
 943
 944   because ../docs is not there if run from /usr/../pythonx.x/site-packages/docutils-test.
 945
 946 Release 0.9.1
 947 =============
 948
 949 same failures as for 0.9 plus
 950
 951 * python 2.3: twice, ignored ::
 952
 953   -             [Errno 2] No such file or directory: 'bogus.csv'.
 954   +             [Errno 2] No such file or directory: u'bogus.csv'.
 955
 956   python 2.3 ::
 957
 958     ======================================================================
 959     ERROR: test_unicode (test_error_reporting.ErrorStringTests)
 960     ----------------------------------------------------------------------
 961     Traceback (most recent call last):
 962       File "/usr/local/lib/python2.3/site-packages/docutils-test/test_error_reporting.py", line 153, in test_unicode
 963         self.assertEqual(u'ImportError: %s' % SafeString(self.bs),
 964     UnicodeDecodeError: 'ascii' codec can't decode byte 0xfc in position 0: ordinal not in range(128)
 965
 966 Note: sf takes some considerable time till the downlods are visible for normal users.
 967   More than 1 hour , the folder files/docutils/0.9.1 exists and the webinterface
 968   correctly summarizes "Totals: 2 Items         1.6 MB" but nothing is shown.
 969
 970 Release 0.9
 971 ===========
 972
 973 * python 2.3 unittest.TestCase has no assertTrue
 974 * python 2.3 keyword dictionaries update method does not support kwargs
 975
 976 Ignored test errors
 977
 978 * python 2.3: unicode problems. 2.3 support is likely to be ended soon.
 979   Systems with only 2.3 might not even know of unicode.
 980
 981 * PIL ``AttributeError: 'module' object has no attribute 'Image'``
 982
 983   A problem in PIL ?
 984   Tested and failiing on
 985
 986   - ubuntu8.04, python 2.4, 2.5
 987   - ubuntu10.04, python 2.6
 988   - ubuntu11.10, python 2.7
 989
 990 * python 2.6.4rc1 has a different error message format::
 991
 992               Problems with "raw" directive path:
 993        -      InputError: [Errno 2] No such file or directory: 'non-existent.file'.
 994        +      InputError: (2, 'No such file or directory').
 995
 996   but not in python 2.6.7