fix rST formatting
This commit is contained in:
parent
1b947b269c
commit
e6b66d1da1
|
@ -54,7 +54,7 @@ Below are the steps to add a new plugin.
|
|||
1. Start by adding a new JSON object, with the name of the repo. ``"pytest-django": {}`` in the example above.
|
||||
|
||||
2. Add an array named ``matrix``. Array items should point to the strategy matrix from the repo's GitHub Actions
|
||||
YAML file. For instance, the ``pytest-django`` example above has a strategy matrix defined as follows:
|
||||
YAML file. For instance, the ``pytest-django`` example above has a strategy matrix defined as follows
|
||||
|
||||
.. code:: YAML
|
||||
|
||||
|
@ -104,15 +104,24 @@ Below are the steps to add a new plugin.
|
|||
|
||||
3. Add a JSON object named ``tox_cmd_build``, with three items: ``base``, ``prefix``, and ``sub``.
|
||||
|
||||
- ``base``: For combination strategies (with ``include``), ``base`` is the field to be used as the basis
|
||||
of the tox environment. For non-combination strategies, this field is an empty string. ``base: "name"``
|
||||
- ``base``:
|
||||
|
||||
- For combination strategies (with ``include``), ``base`` is the field to be used as the basis
|
||||
of the tox environment.
|
||||
|
||||
- For non-combination strategies, this field is an empty string. ``base: "name"``
|
||||
in the ``pytest-django`` example above.
|
||||
|
||||
- ``prefix``: For combination strategies, ``prefix`` is used to [dis]qualify entries in ``base``. For
|
||||
non-combination strategies, this field is an emtpy string. ``prefix: "py"`` in the ``pytest-django``
|
||||
- ``prefix``:
|
||||
|
||||
- For combination strategies, ``prefix`` is used to [dis]qualify entries in ``base``.
|
||||
|
||||
- For non-combination strategies, this field is an emtpy string. ``prefix: "py"`` in the ``pytest-django``
|
||||
example above.
|
||||
|
||||
- ``sub``: For both combination and non-combination strategies, this JSON object gives a RegEx matching
|
||||
- ``sub``:
|
||||
|
||||
- For both combination and non-combination strategies, this JSON object gives a RegEx matching
|
||||
(``pattern``) and a substituition (``replace``) string. Since these are JSON strings, they cannot be
|
||||
represented as a Python raw string (``r""``); ensure to properly escape characters.
|
||||
|
||||
|
@ -133,9 +142,9 @@ Any additions can be verified locally with the following process:
|
|||
|
||||
.. code::
|
||||
|
||||
(.venv) ~/pytest:$> python -m testing.downstream_testing.downstream_runner pytest-order pytest-order/pytest-order.yml test --matrix-exclude 3.6 --dry-run
|
||||
(.venv) ~/pytest:$> python -m testing.downstream_testing.downstream_runner pytest-order pytest-order/main.yml test --matrix-exclude 3.6 --dry-run
|
||||
|
||||
DEBUG | downstream_runner.load_matrix_schema | Loading schema: /home/sommersoft/Dev/pytest-dev/pytest/testing/downstream_testing/action_schemas.json
|
||||
DEBUG | downstream_runner.load_matrix_schema | Loading schema: /home/pytest/testing/downstream_testing/action_schemas.json
|
||||
DEBUG | downstream_runner.load_matrix_schema | 'pytest-order' schema loaded: {'matrix': ['matrix', 'python-version'],
|
||||
'tox_cmd_build': {'base': '', 'prefix': '', 'sub': {'pattern': '(\\d|py\\d)\\.*(\\d+)', 'replace': 'py\\1\\2'}}, 'python_version': 'python-version'}
|
||||
DEBUG | downstream_runner.inject_pytest_dep | toxenv dependencies updated: {'!pytest{60,61,62,624,70}: pytest-xdist', '!pytest50: pytest @ file:///home/pytest'}
|
||||
|
|
Loading…
Reference in New Issue