refactor/build: add Black format check to CI & format codebase #167
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jws-1
changed the title
jws-1
changed the title
m-barker
approved these changes
Apr 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A couple of us are already using the Black formatter in our development environments, this means that if we modify a file that does not adhere to this style, it leads to an annoying diff. This PR adds the Black format checker to our PR CI, meaning that any code that gets PR'd in, has to adhere to the Black formatter. Moreover, I formatted the entire codebase (as I had to do so, to get the check to pass so we can merge this in!).
I also reorganised our
.githubdirectory for future additional workflows, this meant modifying the documentation workflow too, so we need to verify that this is still working (it should run on this being merged in).