This repo exercises the following GitHub actions:
- Automated tests and code-coverage measures
- Uses
tox
and thetox GitHub Actions recipe
to run the repo's tests against Python versions 3.6, 3.7, and 3.8 - Runs measures code-coverage of tests under Python 3.7 (gates on 100% coverage for this repo)
- These jobs run whenever any branch is pushed. Pull requests will also be gated by the passing statuses of these jobs (see the blocked PRs where the tests where made to fail)
- Uses
- Publishing the project wheel to pypi whenever new release is created
- You must save your pypi username and password as secrets associated with the repo
(available under the repo's settings, to the repo owner) as
PYPI_USERNAME
andPYPI_PASSWORD
respectively. (Note that these will be encrypted) - This action will publish to pypi any time you create a new release; i.e. this
new release will become available to users via
pip install rsokl_dummy
- You must save your pypi username and password as secrets associated with the repo
(available under the repo's settings, to the repo owner) as
- Publishing docs whenever the
main
branch gets updated- The resulting documentation looks like this
- The
main
branch only houses the configuration and "plain text" source files for the documentation - The "action" is responsible for installing
sphinx
(and other dependencies specified indocs/requirements.txt
), running sphinx, and publishing the resulting HTML to a separategh-pages
branch- The present sphinx configuration (in
docs/conf.py
) specifies that thesource
andbuild
directory be kept separate - Under the repositories
Settings
, be sure to specify the "GitHub Pages" source branch togh-pages
, and the associated directory todocs/
, if you are copying the configuration from this repo
- The present sphinx configuration (in