search

OpenMS / pyopenms-docs

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.
https://pyopenms.readthedocs.io
Other
43 stars 50 forks source link

Replace flake with flakeheaven for linting #311

Closed jpfeuffer closed 1 year ago

jpfeuffer commented 1 year ago

flakeheaven can be used directly with md,rst,ipynb. Currently we are only testing pure py files. Probably quickest to lint the rst right away but more accurate with the ipynbs. I don't care which one we do.

jpfeuffer commented 1 year ago

And: Make linting actually fail, when it finds something to fix. It currently does not fail.

poshul commented 1 year ago

Flake was fixed, but that doesn't solve rst linting.

matteopilz commented 1 year ago

I have looked into flakeheaven and it looks like there are two options:

  1. Include this one https://github.com/sailingpalmtree/reviewdog-flakehell-action. I have tried shortly and it produces an error. Also, it doesn't seem to have a lot of activity going on in the repo.
  2. Make a GitHub action ourselves with https://github.com/flakeheaven/flakeheaven. This seems like a bigger effort, but the output provided is compatible with GitLab CI, so maybe it's possible to adapt it to GitHub more easily.

Any thoughts on this?

poshul commented 1 year ago

I spent a bit of time looking at the existing action. I think it's probably a better use of time to make a new action ourselves.

On Tue, Jan 24, 2023 at 9:06 AM Matteo Pilz @.***> wrote:

I have looked into flakeheaven and it looks like there are two options:

  1. Include this one https://github.com/sailingpalmtree/reviewdog-flakehell-action. I have tried shortly and it produces an error. Also, it doesn't seem to have a lot of activity going on in the repo.
  2. Make a GitHub action ourselves with https://github.com/flakeheaven/flakeheaven. This seems like a bigger effort, but the output provided is compatible with GitLab CI, so maybe it's possible to adapt it to GitHub more easily.

Any thoughts on this?

— Reply to this email directly, view it on GitHub https://github.com/OpenMS/pyopenms-docs/issues/311#issuecomment-1401522368, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABD3C7PA34JQE5O7XJGQMDWT6EP7ANCNFSM6AAAAAARN5UWAI . You are receiving this because you were assigned.Message ID: @.***>

jpfeuffer commented 1 year ago

Yes. It should be straightforward. We do not need an "action" per see but our own script, yes. It should be just a few lines though.