For Python Engineers
A typical build for a Python project produces a number of useful reports:
- Test results (pytest-html, etc.)
- Test coverage (coverage.py, etc.)
- Python Docs (pydoc, pdoc, etc.)
- API docs (Swagger, ReDoc, etc.)
- ...and more!
Accessing these reports for a remote build on GitHub can be painful. While you can try to address this by using a combination of GitHub actions to post some of these results to GitHub comments or zipping the output files and making them downloadable from the GitHub action page, Stoat is the easiest way to make all of this information trivial to access.
Stoat hosts these outputs and makes them accessible with a single click in a GitHub comment:
The comment can also track build times and other metrics. Additionally, the comment is fully customizable, so you can choose what to display and how it should appear in the comment. Visit our templating documentation for more information about customization.
Example Repo
See a real build that generates and links to Python build reports in this pull request.
Enabling and finding the paths to HTML reports is often the hardest part about setting up Stoat. The example-python source code contains examples of setting up a few HTML test reports and can be used as a reference.
Relevant Tutorials
To get started with Stoat as a Python engineer, try out the following tutorials: