Development

To contribute to pytest-html you can use Pipenv to manage a python virtual environment and pre-commit to help you with styling and formatting.

To setup the virtual environment and pre-commit, run:

$ pipenv install --dev
$ pipenv run pre-commit install

If you're not using Pipenv, to install pre-commit, run:

$ pip install pre-commit
$ pre-commit install

Automated Testing

All pull requests and merges are tested in Travis CI based on the .travis.yml file.

Usually, a link to your specific travis build appears in pull requests, but if not, you can find it on the pull requests page

The only way to trigger Travis CI to run again for a pull request, is to submit another change to the pull branch.

You can do this with git commit --allow-empty

You will need Tox installed to run the tests against the supported Python versions. If you're using Pipenv it will be installed for you.

With Pipenv, run:

$ pipenv run tox

Otherwise, to install and run, do:

$ pip install tox
$ tox

Follow these steps to release a new version of the project:

Update your local master with the upstream master (git pull --rebase upstream master)
Create a new branch and update CHANGES.rst with the new version, today's date, and all changes/new features
Commit and push the new branch and then create a new pull request
Wait for tests and reviews and then merge the branch
Once merged, update your local master again (git pull --rebase upstream master)
Tag the release with the new release version (git tag v<new tag>)
Push the tag (git push upstream --tags)
Done. You can monitor the progress on Travis