-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
[workflows] reorg #1102
[workflows] reorg #1102
Conversation
* The `python-format-and-tests.yml` workflow did too many jobs in one workflow and didn't allow us to treat each job it did with different care. * We want code to be formatted with `black` and we want this to be mandatory in code reviews. Let's do this in `check-python-code-formatting-with-black.yml` from now on. * We want python tests to pass, so let's do this in `check-python-code-with-pytest.yml`. * We want to generate coverage but we potentially don't want to make this mandatory for pull requests. See `check-python-code-coverage.yml`. * The `retest.yml` just got a new name. * The `Makefile` got dedicated target we can use from within the workflows.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We want code to be formatted with black and we want this to be mandatory in code reviews.
I don't remember ever discussing this part with the rest of the team. IMHO, it's a good idea to have a tool that helps to check code formatting, but I've seen this test fail with super-strict results, e.g. complaining about how the lines of imports should be organized/grouped together.
Is it possible to reduce that requirement?
There are 2 tests pending ( |
Actually, the pre-commit git hook which should run on every
IMHO. No because I don't see why not to follow the idea that |
The two pending tests are the ones, that I've split up in this PR:
When this PR gets approved I'm going to adjust the branch protection rule to remove the two tests and instead add the pytest run and black formatting individually. At least that was the plan. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While I disagree about the code style and I believe it should be relaxed, I have to recognize this PR is not changing the current behavior.
So, LGTM.
The branch protection rules for Unfortunately the old branch protection way of configuring things only shows the job names and not the workflow names. In the future we might wanna look into rulesets. |
The
python-format-and-tests.yml
workflow did too many jobs in one workflow and didn't allow us to treat each job it did with different care.We want code to be formatted with
black
and we want this to be mandatory in code reviews. Let's do this incheck-python-code-formatting-with-black.yml
from now on.We want python tests to pass, so let's do this in
check-python-code-with-pytest.yml
.We want to generate coverage but we potentially don't want to make this mandatory for pull requests. For example, see

for this PR which doesn't change anything regarding coverage numbers. See
check-python-code-coverage.yml
.The
retest.yml
just got a new name:retest-chroots-on-testing-farm.yml
.The
Makefile
got dedicated target we can use from within the workflows.In order to unblock this PR I first have to get approval for it and then I can tune the branch protection settings to no longer require these old workflows
but the new ones