dinglehopper icon indicating copy to clipboard operation
dinglehopper copied to clipboard

GitHub Actions

Open mikegerber opened this issue 2 years ago • 2 comments

  • [x] Port CI from CircleCI to GitHub Actions
    • [x] Run tests in GitHub Actions
    • [x] Replace CI badge
    • [x] Review Black job
    • [x] Port Black job
    • [x] Remove project in CircleCI
    • [x] Remove .circleci/
  • [ ] Release using the workflow we prototyped in setuptools_ocrd
    • [ ] Diff again (had to fix issues here)
  • [x] Releasing should depend on the Test workflow
  • [ ] Setup tests for PRs (see also #68)
  • [ ] This should serve as a template for other projects (ideally: reusable workflow)
  • [ ] Review documentation in README*
  • [ ] "just Black" workflow for PRs + master/main (see comment below for concepts)
  • [ ] pip wheel cache
  • [ ] Review Security guides
  • [ ] Releasing on PYPI somehow requires a manual review now?

mikegerber avatar Aug 04 '23 17:08 mikegerber

  * [ ]  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.

  2. 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.

  3. ~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.

mikegerber avatar Oct 23 '23 12:10 mikegerber