EnergySystemsModellingLab / MUSE_2.0

Welcome to the MUSE 2.0 repository
GNU General Public License v3.0
1 stars 0 forks source link

CI: Check that API documentation builds without warnings #126

Closed alexdewar closed 3 months ago

alexdewar commented 3 months ago

I just noticed that cargo doc is emitting a warning for our code, but I didn't noticed until now, because, while we do build and the API documentation on pushes to main, at no point do we check for warnings.

This PR adds a workflow to do this for PRs. The docs workflow is also changed to fail on warnings; while this means that docs with warnings won't be published, it also means we'll get an email if we break the documentation on main.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 79.89%. Comparing base (5f54705) to head (5cc62f0). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #126 +/- ## ======================================= Coverage 79.89% 79.89% ======================================= Files 9 9 Lines 199 199 ======================================= Hits 159 159 Misses 40 40 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.