search

lsst-epo / citizen-science-notebooks

A collection Jupyter notebooks that can be used to associate Rubin Science Platform data to a Zooniverse citizen science project.
3 stars 1 forks source link

Discovery - See what Github Actions are available for linting Jupyter Notebooks or automatically running Flake8 validation #99

Closed ericdrosas87 closed 3 months ago

ericdrosas87 commented 3 months ago

User story

As the git-ops engineer of the citSci pipeline, I need to see if there are any Github Actions available for linting the code cells of a Jupyter Notebook or an action from running Flake8 LCI upon PR creation/pushing new commits to a PR so that the notebooks align with RTN-045 standards.

Definition of done

I have collected enough information to present options to the broader citSci group.

ericdrosas87 commented 3 months ago

This Action looks promising: https://github.com/marketplace/actions/python-code-quality-and-lint

ericdrosas87 commented 3 months ago

The gist my findings is that this should be a fairly minor effort, likely 1 point on the high end of the estimate. There are a few Github Actions that support Flake8 validation, and RTN-045 outlines the config file setup that is suggested by CST. The Flake8 validation can occur upon PR creation/pushing commits to said PR, adding a label to a PR, etc.