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

Make Black in CI more user friendly #1002

Closed
PGijsbers opened this issue Nov 16, 2020 · 0 comments
Closed

Make Black in CI more user friendly #1002

PGijsbers opened this issue Nov 16, 2020 · 0 comments
Labels
CI About continious integration enhancement

Comments

@PGijsbers
Copy link
Collaborator

PGijsbers commented Nov 16, 2020

When files are uploaded which are not Black-formatted, CI gives a less than helpful message about what is wrong. We'll have to look into what is possible, but I would consider the following alternatives:

  • Have a bot which lists the Black changes, and you can interact with to have it commit those changes for you (either to identify a bot we want to adopt, or to create one)
  • Apply Black formatting if needed and re-commit automatically (is that desirable? By seeing the feedback, at times I get ideas for further refactoring)
  • Show the changes in the CI log (maybe there is a Black option, otherwise an added git diff should suffice)

The main use case is to make edits through the web interface smoother. E.g. I had set up this pr through the web to keep it quick, but ended up pulling my branch anyway to see what changes I was required to make to pass pre-commit. It also helps users which have incorrectly configured their pre-commit (we could also have the bot point that out).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI About continious integration enhancement
Projects
None yet
Development

No branches or pull requests

2 participants