Commit 21858e0e authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: fix several tbc-check warnings

parent 9587a06c

README.md

+5 −0
Original line number Diff line number Diff line
@@ -93,6 +93,7 @@ It is bound to the `build` stage, and uses the following variables: 


| Input / Variable         | Description                        | Default value     |

| ------------------------ | ---------------------------------- | ----------------- |

| `pylint-enabled` / `PYLINT_ENABLED` | Set to `true` to enable the `pylint` job                  | _none_ (disabled) |

| `pylint-args` / `PYLINT_ARGS` | Additional [pylint CLI options](http://pylint.pycqa.org/en/latest/user_guide/run.html#command-line-options) |  _none_           |

| `pylint-files` / `PYLINT_FILES` | Files or directories to analyse   | _none_ (by default analyses all found python source files) |
@@ -123,6 +124,7 @@ It is bound to the `build` stage, and uses the following variables: 


| Input / Variable         | Description                                                          | Default value           |

| ------------------------ | -------------------------------------------------------------------- | ----------------------- |

| `unittest-enabled` / `UNITTEST_ENABLED` | Set to `true` to enable the `unittest` job                  | _none_ (disabled) |

| `unittest-args` / `UNITTEST_ARGS` | Additional xmlrunner/unittest CLI options                            | _none_                  |



:information_source: use a `.coveragerc` file at the root of your Python project to control the coverage settings.
@@ -155,6 +157,7 @@ It is bound to the `build` stage, and uses the following variables: 


| Input / Variable         | Description                                                                                                                                   | Default value           |

| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |

| `pytest-enabled` / `PYTEST_ENABLED` | Set to `true` to enable the `pytest` job                  | _none_ (disabled) |

| `pytest-args` / `PYTEST_ARGS` | Additional [pytest](https://docs.pytest.org/en/stable/usage.html) or [pytest-cov](https://github.com/pytest-dev/pytest-cov#usage) CLI options | _none_                  |



:information_source: use a `.coveragerc` file at the root of your Python project to control the coverage settings.
@@ -187,6 +190,7 @@ It is bound to the `build` stage, and uses the following variables: 


| Input / Variable         | Description                                                                             | Default value           |

| ------------------------ | --------------------------------------------------------------------------------------- | ----------------------- |

| `nosetests-enabled` / `NOSETESTS_ENABLED` | Set to `true` to enable the `nose` job                  | _none_ (disabled) |

| `nosetests-args` / `NOSETESTS_ARGS` | Additional [nose CLI options](https://nose.readthedocs.io/en/latest/usage.html#options) | _none_                  |



By default coverage will be run on all the project directories. You can restrict it to your packages by setting the `$NOSE_COVER_PACKAGE` variable.
@@ -310,6 +314,7 @@ It is bound to the `build` stage, and uses the following variables: 


| Input / Variable         | Description                        | Default value     |

| ------------------------ | ---------------------------------- | ----------------- |

| `mypy-enabled` / `MYPY_ENABLED` | Set to `true` to enable the `mypy` job                  | _none_ (disabled) |

| `mypy-args` / `MYPY_ARGS` | Additional [mypy CLI options](https://mypy.readthedocs.io/en/stable/command_line.html) | _none_           |

| `mypy-files` / `MYPY_FILES` | Files or directories to analyse   | _none_ (by default analyses all found python source files) |

kicker.json

+4 −4
Original line number Diff line number Diff line
@@ -61,8 +61,8 @@ 
      "enable_with": "PYTHON_PACKAGE_ENABLED"

    },

    {

      "id": "py-lint",

      "name": "py-lint",

      "id": "pylint",

      "name": "pylint",

      "description": "Code analysis based on [pylint](http://pylint.pycqa.org/en/latest/) Python lib.",

      "enable_with": "PYLINT_ENABLED",

      "variables": [
@@ -105,8 +105,8 @@ 
      ]

    },

    {

      "id": "py-nosetests",

      "name": "py-nosetests",

      "id": "nose",

      "name": "nose",

      "description": "Unit tests based on [nose](https://nose.readthedocs.io/) framework",

      "enable_with": "NOSETESTS_ENABLED",

      "variables": [

templates/gitlab-ci-python.yml

+1 −1
Original line number Diff line number Diff line
@@ -83,7 +83,7 @@ spec: 
      description: Additional [pytest](https://docs.pytest.org/en/stable/usage.html) or [pytest-cov](https://github.com/pytest-dev/pytest-cov#usage) CLI options

      default: ''

    nosetests-enabled:

      description: Enable nosetest

      description: Enable nose

      type: boolean

      default: false

    nosetests-args: