howto.txt

* Release checklist

- Check that the current virtualenv matches the current coverage branch.
- Version number in coverage/version.py
        version_info = (4, 0, 2, 'alpha', 1)
        version_info = (4, 0, 2, 'beta', 1)
        version_info = (4, 0, 2, 'candidate', 1)
        version_info = (4, 0, 2, 'final', 0)
- Python version number in classifiers in setup.py
- Copyright date in NOTICE.txt
- Update CHANGES.rst, including release date.
- Update README.rst
    - "New in x.y:"
    - Python versions supported
- Update docs
    - Version, date and python versions in doc/index.rst
    - Version and copyright date in doc/conf.py
        - Look for CHANGEME comments
    - Don't forget the man page: doc/python-coverage.1.txt
    - Check that the docs build correctly:
        $ tox -e doc
    - Done with changes to source files, check them in.
        - git push
    - Generate new sample_html to get the latest, incl footer version number:
        make clean
        pip install -e .
        cd ~/cog/trunk
        rm -rf htmlcov
        coverage run --branch --source=cogapp -m pytest -k CogTestsInMemory
        coverage combine
        coverage html
        - IF PRE-RELEASE:
            rm -f ~/coverage/trunk/doc/sample_html_beta/*.*
            cp -r htmlcov/ ~/coverage/trunk/doc/sample_html_beta/
        - IF NOT PRE-RELEASE:
            rm -f ~/coverage/trunk/doc/sample_html/*.*
            cp -r htmlcov/ ~/coverage/trunk/doc/sample_html/
        cd ~/coverage/trunk
        - IF NOT PRE-RELEASE:
            check in the new sample html
    - Build and publish docs:
        - IF PRE-RELEASE:
            $ make publishbeta
        - ELSE:
            $ make publish
- Kits:
    - Start fresh:
        - $ make sterile
    - Source kit and wheels:
        - $ make kit wheel
    - Linux wheels:
        - $ make manylinux
    - Windows kits
        - wait for over an hour for Appveyor to build kits.
            - https://ci.appveyor.com/project/nedbat/coveragepy
        - $ make download_appveyor
    - examine the dist directory, and remove anything that looks malformed.
- Update PyPI:
    - upload kits:
        - $ make kit_upload
- Tag the tree
    - git tag coverage-3.0.1
    - git push
    - git push --tags
- Bump version:
    - coverage/version.py
        - increment version number
        - IF NOT PRE-RELEASE:
            - set to alpha-0 if just released
    - CHANGES.rst
        - add an "Unreleased" section to the top.
- push git changes
- Update nedbatchelder.com
    - Blog post?
- Update readthedocs
    - visit https://readthedocs.org/projects/coverage/versions/
        - find the latest tag in the inactive list, edit it, make it active.
        - keep just the latest version of each x.y release, make the rest inactive.
    - IF NOT PRE-RELEASE:
        - visit https://readthedocs.org/projects/coverage/builds/
        - wait for the new tag build to finish successfully.
        - visit https://readthedocs.org/dashboard/coverage/versions/
        - change the default version to the new version
- Visit the fixed issues on GitHub and mention the version it was fixed in.
- Announce on coveragepy-announce@googlegroups.com .
- Announce on TIP.


* Testing

- Testing of Python code is handled by tox.
    - Create and activate a virtualenv
    - pip install -r requirements/dev.pip
    - $ tox

- Testing on Linux:
    - $ docker run -it --init --rm -v `pwd`:/io quay.io/pypa/manylinux1_x86_64 /io/ci/manylinux.sh test

- For complete coverage testing:

    $ make metacov

    This will run coverage.py under its own measurement.  You can do this in
    different environments (Linux vs. Windows, for example), then copy the data
    files (.metacov.*) to one machine for combination and reporting.  To
    combine and report:

    $ make metahtml

- To run the Javascript tests:

    open tests/js/index.html in variety of browsers.