Skip to content

Commit 73abffd

Browse files
jacobtylerwallsDanielNoord
authored andcommitted
Correct documentation about running primer locally
1 parent e44eec6 commit 73abffd

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

doc/development_guide/contributor_guide/tests/launching_test.rst

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,25 @@ Primer tests
5757

5858
Pylint also uses what we refer to as ``primer`` tests. These are tests that are run automatically
5959
in our Continuous Integration and check whether any changes in Pylint lead to crashes or fatal errors
60-
on the ``stdlib`` and a selection of external repositories.
60+
on the ``stdlib``, and also assess a pull request's impact on the linting of a selection of external
61+
repositories by posting the diff against ``pylint``'s current output as a comment.
6162

62-
To run the ``primer`` tests you can add either ``--primer-stdlib`` or ``--primer-external`` to the
63-
pytest_ command. If you want to only run the ``primer`` you can add either of their marks, for example::
63+
To run the primer test for the ``stdlib``, which only checks for crashes and fatal errors, you can add
64+
``--primer-stdlib`` to the pytest_ command. For example::
6465

6566
pytest -m primer_stdlib --primer-stdlib
6667

67-
The external ``primer`` can be run with::
68+
To produce the output generated on Continuous Integration for the linting of external repositories,
69+
run these commands::
6870

69-
pytest -m primer_external_batch_one --primer-external # Runs batch one
71+
python tests/primer/__main__.py prepare --clone
72+
python tests/primer/__main__.py run --type=pr
73+
74+
To fully simulate the process on Continuous Integration, you should then checkout ``main``, and
75+
then run these commands::
76+
77+
python tests/primer/__main__.py run --type=main
78+
python tests/primer/__main__.py compare
7079

7180
The list of repositories is created on the basis of three criteria: 1) projects need to use a diverse
7281
range of language features, 2) projects need to be well maintained and 3) projects should not have a codebase

0 commit comments

Comments
 (0)