search

GuyHoozdis / hypermodern-python

A template based on "The Hypermodern Python Project"
MIT License
0 stars 0 forks source link

Chapter 6/ci cd #9

Closed GuyHoozdis closed 1 month ago

GuyHoozdis commented 1 month ago

Why Are We Doing This?

This changeset add several documentation related features and configures them to be maintained, along with the codebase and package publishing, in an automated fashion.

Test Plan

  1. The automated test suite passes (run manually if needed).
  2. Verify the current version is not available on PyPi.
    • poetry version
    • pip index versions hypermodern-guyhoozdis
  3. Verify documentation can be built with nox -s docs
  4. Verify that codecov is receiving coverage data for this branch.
  5. After merge
    • Verify the documentation is built and hosted on Read the Docs.
    • Verify the documentation badge displays passing.
    • Verify the codecov badge displays 100%.
    • Verify the PyPi badge shows the last published version.