This project demonstrates use of Github Actions to build and test a Python project.
- Create a repository on Github containing this starter code
- Add a Github Action to run unit tests.
- Pull from Github so your local repositry has the action (update your local repo).
- The Github Action should initially fail.
- Fix the code and tests locally until they pass on your machine.
- Push the fix to Github.
- Observe how Github automatically reruns your Action and updates the badge.
- Add a Github "Badge" showing test status to this README.
- Create a separate Github Action for flake8 and flake8-docstrings.
- Modify the action so that it does exit with a non-zero exit code when errors are found.
- Pull the Github repo, again.
- Fix the style problems until your code passes flake8.
- Push to Github.
Use Github to perform code coverage and generate a report. This will help you find places where you need to improve your tests.
- Modify your Github Action for unit tests to run tests with code coverage
- Send a coverage report (as xml) to https://codecov.io
- Add a Codecov badge to this README