qurator-spk / dinglehopper

An OCR evaluation tool
Apache License 2.0
58 stars 12 forks source link

GitHub Actions #87

Open mikegerber opened 1 year ago

mikegerber commented 1 year ago
mikegerber commented 10 months ago
  * [ ]  Review Black job

It didn't do much yet. The most useful behavior for the (future) GitHub Actions Black workflow would be:

1. a. Run Black on PRs and add fixes by adding a commit to the PR b. Run Black on master/main by creating a PR

Running Black checks = requiring the code to be conforming would be annoying, I'd like to avoid being annoying. If devs want to be annoyed, they can choose to enable pre-commit.

  1. Black workflow should be reusable. I want to do this once properly and then just add a tested config when I want it in another project.

  2. ~Test if running pre-commit's fixes automatically (incl. Black) would do it. But~ having a "just Black" workflow would be nice because I think this would be easier to sell to other team member's projects than the whole pre-commit stuff. → Decided to have a reusable "just Black" workflow.