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

Set up Github Action workflow for running Flake8 automatically upon PR creation #100

Closed ericdrosas87 closed 2 months ago

ericdrosas87 commented 3 months ago

User story

As the git-ops engineer of the citSci dev effort, I need to set up a Github workflow with an Action that performs automatic Flake 8 validation upon PR creation so the notebooks continuously are validated to adhere to RTN-045 standards.

Definition of done

I have added a workflow that runs a Github Action that automatically validates the notebooks against Flake8 rules.

ericdrosas87 commented 3 months ago

Image

Example of failed validation of utils.py

ericdrosas87 commented 3 months ago

Image

Example of failed validation for notebooks, with annotations on the code diff view

ericdrosas87 commented 3 months ago

Image

One failure, one success during open PR