summaryrefslogtreecommitdiff
path: root/doc/development_guide
diff options
context:
space:
mode:
authorJacob Walls <jacobtylerwalls@gmail.com>2022-11-12 21:02:46 -0500
committerDaniƫl van Noord <13665637+DanielNoord@users.noreply.github.com>2022-11-13 12:23:27 +0100
commit73abffd80fdb0429a72a512e332190c4ec5cb4bb (patch)
tree989ef18f2f700a939f03d595294b7f456502b55c /doc/development_guide
parente44eec69560febea194b31c3c7a16260a9e1da1b (diff)
downloadpylint-git-73abffd80fdb0429a72a512e332190c4ec5cb4bb.tar.gz
Correct documentation about running primer locally
Diffstat (limited to 'doc/development_guide')
-rw-r--r--doc/development_guide/contributor_guide/tests/launching_test.rst19
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/development_guide/contributor_guide/tests/launching_test.rst b/doc/development_guide/contributor_guide/tests/launching_test.rst
index b982bbbeb..02114f01f 100644
--- a/doc/development_guide/contributor_guide/tests/launching_test.rst
+++ b/doc/development_guide/contributor_guide/tests/launching_test.rst
@@ -57,16 +57,25 @@ Primer tests
Pylint also uses what we refer to as ``primer`` tests. These are tests that are run automatically
in our Continuous Integration and check whether any changes in Pylint lead to crashes or fatal errors
-on the ``stdlib`` and a selection of external repositories.
+on the ``stdlib``, and also assess a pull request's impact on the linting of a selection of external
+repositories by posting the diff against ``pylint``'s current output as a comment.
-To run the ``primer`` tests you can add either ``--primer-stdlib`` or ``--primer-external`` to the
-pytest_ command. If you want to only run the ``primer`` you can add either of their marks, for example::
+To run the primer test for the ``stdlib``, which only checks for crashes and fatal errors, you can add
+``--primer-stdlib`` to the pytest_ command. For example::
pytest -m primer_stdlib --primer-stdlib
-The external ``primer`` can be run with::
+To produce the output generated on Continuous Integration for the linting of external repositories,
+run these commands::
- pytest -m primer_external_batch_one --primer-external # Runs batch one
+ python tests/primer/__main__.py prepare --clone
+ python tests/primer/__main__.py run --type=pr
+
+To fully simulate the process on Continuous Integration, you should then checkout ``main``, and
+then run these commands::
+
+ python tests/primer/__main__.py run --type=main
+ python tests/primer/__main__.py compare
The list of repositories is created on the basis of three criteria: 1) projects need to use a diverse
range of language features, 2) projects need to be well maintained and 3) projects should not have a codebase