/ howto.txt

* Release checklist

- Test on:
    - Windows
    - Ubuntu
    - Mac
    - Pythons 2.3, 2.4, 2.5, 2.6, 2.7, 3.1, 3.2, 3.3
- Version number in coverage/
    - 3.1a1, 3.1b1, 3.1c1, 3.1
- Update CHANGES.txt, including release date.
- Update docstring in, including "New in x.y:"
- Update docs
    - Version, date, and changes in doc/changes.rst
    - Version and date in doc/index.rst
    - Version and copyright date in doc/
    - Version --version output in doc/install.rst
    - Generate new sample_html to get the latest, incl footer version number:
        python develop
        cd C:\ned\cog\trunk
        rmdir/s/q htmlcov
        coverage run --branch --source=cogapp -m cogapp.test_cogapp CogTestsInMemory
        coverage html
        - IF BETA:
            copy/y htmlcov\*.* C:\ned\coverage\trunk\doc\sample_html_beta
        - ELSE:
            copy/y htmlcov\*.* C:\ned\coverage\trunk\doc\sample_html
    - IF BETA:
        - Build and publish docs:
            $ make publishbeta
    - ELSE:
        - Build and publish docs:
            $ make publish
- Kits:
    - Source kit:
        - $ make kit
    - Windows .exe for each Python
        - $ tox -c tox_winkits.ini
- Update PyPi:
    - $ make pypi
    - upload the kits:
        - $ make kit_upload
        - $ tox -c tox_winkits.ini upload
        # note: this seems to try to upload each file twice, so you'll have a
        # successful upload, then a failure, but the file gets there.
    - Visit :
        - show/hide the proper versions.
- Tag the tree
    - hg tag -m "Coverage 3.0.1" coverage-3.0.1
- Update
    - Edit webfaction.htaccess to make sure the proper versions are mapped to /beta
    - Blog post?
- Update bitbucket:
    - Issue tracker should get new version number in picker.
    # Note: don't delete old version numbers: it marks changes on the tickets
    # with that number.
- Announce on .
- Announce on TIP.
- Ask Christophe Zwerschke ( to build win64 kits.

* Building

- Install fixtar on any Windows Python used to make source kits:
- Create PythonXX\Lib\distutils\distutils.cfg::
    compiler = mingw32

* Testing

- Testing of Python code is handled by tox.
    - Create a virtualenv
    - install tox into it
    - activate the virtualenv
    - $ tox

- For complete coverage testing:

    $ make metacov

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

    $ make metahtml

- For testing on Python <= 2.4:

    - Set up the Python as your current python, probably with a virtualenv.
    - $ . ./

- To run the Javascript tests:

    open tests/js/index.html in variety of browsers.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.