Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GitHub Actions #87

Open
8 of 17 tasks
mikegerber opened this issue Aug 4, 2023 · 1 comment
Open
8 of 17 tasks

GitHub Actions #87

mikegerber opened this issue Aug 4, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request maintenance

Comments

@mikegerber
Copy link
Member

mikegerber commented Aug 4, 2023

  • Port CI from CircleCI to GitHub Actions
    • Run tests in GitHub Actions
    • Replace CI badge
    • Review Black job
    • Port Black job
    • Remove project in CircleCI
    • Remove .circleci/
  • Release using the workflow we prototyped in setuptools_ocrd
    • Diff again (had to fix issues here)
  • Releasing should depend on the Test workflow
  • Setup tests for PRs (see also No tests are run for PRs? #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
Copy link
Member Author

mikegerber commented Oct 23, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request maintenance
Projects
None yet
Development

No branches or pull requests

1 participant