detect if API breaks on PR

[mikemhenry]

Developers certificate of origin

• I certify that this contribution is covered by the MIT License here and the Developer Certificate of Origin at https://developercertificate.org/.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.32%. Comparing base (378147c) to head (9620de2).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #727      +/-   ##
==========================================
- Coverage   94.13%   92.32%   -1.81%     
==========================================
  Files         134      134              
  Lines        9786     9786              
==========================================
- Hits         9212     9035     -177     
- Misses        574      751     +177     

Flag	Coverage Δ
fast-tests	92.32% <ø> (?)
slow-tests	?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mikemhenry]

See https://mkdocstrings.github.io/griffe/checking/#detected-breakages

We get errors, but that is because we are breaking things, after the 1.0 tag, we can use this check to make sure we update the change log with breakage.

For example:
https://github.com/OpenFreeEnergy/openfe/actions/runs/7925490023/job/21638754579?pr=727#step:4:65

[IAlibay]

This is really cool @mikemhenry - I personally like it.