Commit 67cddb61 authored by Ewout Helmich's avatar Ewout Helmich

Merge branch 'tnutma/docs/expand-black' into 'master'

Update black documentation

See merge request omegacen/ci-templates!41
parents de22542a 6fbdbbaf
......@@ -13,11 +13,24 @@ Usage
black.yml
-------------
By including this template, all Python files will be linted with `black`_.
If they are not properly formatted according to black, the CI will
fail and an assist-MR will be created to automatically fix the formatting.
By including this template in your project, its Python files will be linted
with `black`_ 19.10b0. The behaviour is different for the default branch
and for Merge Requests (MRs):
To use it, follow these steps:
* For the default / master / release branch(es):
* All Python files will be checked with black.
* If they are not all properly formatted according to black, the CI will fail.
* For MRs:
* Only the changed files will be checked with black.
* If they are not properly formatted according to black, the CI will fail.
* An assist-MR will be created to automatically fix the formatting.
* Upon merging this assist-MR, the changed files are checked again
and the CI should pass.
To use the black CI template, follow these steps:
#. Add `CI Bot`_ as a member to your project in at least the Developer role.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment