zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Mention bootstrap_pip_spec in the tests docs

Browse Source
This commit is contained in:
Jeremy Tuloup
2020-04-27 12:15:13 +02:00
parent 914a1e8c7b
commit 5f693c2cbf
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/contributing/tests.rst
View File

@@ -39,12 +39,10 @@ You can then run the tests with:
.. code-block:: bash .. code-block:: bash
.circleci/integration-test run-test <name-of-run> <test-file-names> .circleci/integration-test.py run-test <name-of-run> <test-file-names>
- ``<name-of-run>`` is an identifier for the tests - you can choose anything you want
``<name-of-run>`` is an identifier for the tests - you can choose - ``<test-file-names>>`` is list of test files (under ``integration-tests``) that should be run in one go.
anything you want. ``<test-file-names>>`` is list of test files
(under ``integration-tests``) that should be run in one go.
For example, to run all the basic tests, you would write: For example, to run all the basic tests, you would write:
@@ -57,3 +55,11 @@ For example, to run all the basic tests, you would write:
This will run the tests in the three files against the same installation This will run the tests in the three files against the same installation
of TLJH and report errors. of TLJH and report errors.
If you would like to run the tests with a custom pip spec for the bootstrap script, you can use the ``--bootstrap_pip_spec``
parameter:
.. code-block:: bash
.circleci/integration-test.py run-test <name-of-run> <test-file-names> \
--bootstrap_pip_spec="git+https://github.com/your-username/the-littlest-jupyterhub.git@branch-name"