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

Initial implementation of Flake8 action #101

Closed ericdrosas87 closed 2 months ago

ericdrosas87 commented 3 months ago

Initial implementation of Flake8 action

ericdrosas87 commented 3 months ago

Resolves #100

ericdrosas87 commented 3 months ago

@beckynevin We'll need to figure out what to do about the notebooks in the experimental_notebooks folder. As far as I can tell, the action added by this PR is the only Flake8 Action that can also validate Jupyter Notebooks. I confirmed with the maintainer of the Action that there's no way to ignore/exclude a subset of notebooks, so the Action will parse the entire repo for any .ipynb files, including the experimental notebooks and unless we bring them up to snuff will continue to throw off validation.

There are a few options:

  1. Move the experimental notebooks out of this repo into their own repo
  2. Keep them on their own branch and remove them from the main branch
  3. Change the file extension to something like ipynbx so they aren't picked up by the Action
  4. Make the experimental Flake8 compliant

Let me know your thoughts when you have a moment.

beckynevin commented 3 months ago

@beckynevin We'll need to figure out what to do about the notebooks in the experimental_notebooks folder. As far as I can tell, the action added by this PR is the only Flake8 Action that can also validate Jupyter Notebooks. I confirmed with the maintainer of the Action that there's no way to ignore/exclude a subset of notebooks, so the Action will parse the entire repo for any .ipynb files, including the experimental notebooks and unless we bring them up to snuff will continue to throw off validation.

There are a few options:

  1. Move the experimental notebooks out of this repo into their own repo
  2. Keep them on their own branch and remove them from the main branch
  3. Change the file extension to something like ipynbx so they aren't picked up by the Action
  4. Make the experimental Flake8 compliant

Let me know your thoughts when you have a moment.

You fixed this right? Because I currently don't see them being reviewed in the action.

@beckynevin We'll need to figure out what to do about the notebooks in the experimental_notebooks folder. As far as I can tell, the action added by this PR is the only Flake8 Action that can also validate Jupyter Notebooks. I confirmed with the maintainer of the Action that there's no way to ignore/exclude a subset of notebooks, so the Action will parse the entire repo for any .ipynb files, including the experimental notebooks and unless we bring them up to snuff will continue to throw off validation.

There are a few options:

  1. Move the experimental notebooks out of this repo into their own repo
  2. Keep them on their own branch and remove them from the main branch
  3. Change the file extension to something like ipynbx so they aren't picked up by the Action
  4. Make the experimental Flake8 compliant

Let me know your thoughts when you have a moment.

This looks like it was resolved, right? I can't quite tell when I'm looking at the validate action for notebooks which notebook it's looking at but it looks like you solved this and now it's just looking within the main folder right?