internetarchive / openlibrary

One webpage for every book ever published!
https://openlibrary.org
GNU Affero General Public License v3.0
4.96k stars 1.24k forks source link

Remove .github/workflows/ruff.yml #9230

Open RayBB opened 1 month ago

RayBB commented 1 month ago

Problem

I think we can remove .github/workflows/ruff.yml now that we have ruff running in pre-commit on each PR anyway.

Any reason to keep this around?

Evidence / Screenshot

image

Relevant URL(s)

Reproducing the bug

  1. Go to ...
  2. Do ...

Context

Notes from this Issue's Lead

Proposal & constraints

Related files

https://github.com/internetarchive/openlibrary/blob/master/.github/workflows/ruff.yml

Stakeholders

CC: @scottbarnes

RayBB commented 1 month ago

@scottbarnes any opinions on this one?

scottbarnes commented 1 month ago

I just cloned from git@github.com:internetarchive/openlibrary.git, made a branch, made a change, and committed it, and pre-commit doesn't look to run by default, so I think if we remove this, then ruff will only run for people who use pre-commit, and that's not everyone, so we may end up more likely to commit code that won't pass the linting.

If that's correct, and that's a big if, then I think we should probably keep this workflow around.

RayBB commented 1 month ago

@scottbarnes I think you're talking about the pre-commit hooks running locally on your machine. This file should not impact them because it is only used by GitHub Actions. https://github.com/internetarchive/openlibrary/blob/master/.github/workflows/ruff.yml

However, we have a different github CI that runs pre-commit which in turn runs ruff for us and commits the results to the branch. So I think that this ruff workflow is no longer needed as a separate workflow.