NOAA-GFDL / fre-cli

Python-based command line interface for FRE (FMS Runtime Environment) to compile and run FMS-based models and post-process their output.
GNU Lesser General Public License v3.0
3 stars 7 forks source link

Add pipeline badges to README! #145

Closed ilaflott closed 3 weeks ago

ilaflott commented 1 month ago

Describe your changes

This PR will add status badges to the repository's README, indicating latest release(s), pipeline success, and ideally, code coverage metrics / test results / linting results.

Checklist before requesting a review

ilaflott commented 3 weeks ago

maybe this is a doc workflow thing, actually.

what if i pylint/pytest/pytest-cov in here: https://github.com/NOAA-GFDL/fre-cli/blob/507474a9c20e7e1ce360f8414bb82bae119ef847/.github/workflows/documentation.yml#L12

then call genbagdge on the reports to create the svg, upload the generated badge imgs as artifacts to carry it through to the deploy step: https://github.com/NOAA-GFDL/fre-cli/blob/507474a9c20e7e1ce360f8414bb82bae119ef847/.github/workflows/documentation.yml#L21-L28

then, we have something in fre-cli/docs hyperlink that uploaded image. and the forward-facing README.md links to that from the docs.

ilaflott commented 3 weeks ago

This is ready to go!!!

see: https://noaa-gfdl.github.io/fre-cli/index.html see: https://noaa-gfdl.github.io/fre-cli/badges.html see: https://github.com/NOAA-GFDL/fre-cli/blob/add_badges/README.md

ilaflott commented 3 weeks ago

This is ready to go!!!

see: https://noaa-gfdl.github.io/fre-cli/index.html see: https://noaa-gfdl.github.io/fre-cli/badges.html see: https://github.com/NOAA-GFDL/fre-cli/blob/add_badges/README.md

and by "ready to go" i really mean, ready for someone to look at.

BEFORE ANYONE CLICKS MERGE: see unresolved comments on code that i have left.

ilaflott commented 3 weeks ago

ready for APPROVAL

need to fix the workflow trigger, but what we have here is now: https://noaa-gfdl.github.io/fre-cli/py-modindex.html