Skip to content

Commit 42fa10c

Browse files
authored
Merge pull request #2708 from OSInside/delete_tox_artifacts
Drop still present tox artifacts
2 parents 9a526ed + 8949fce commit 42fa10c

File tree

3 files changed

+5
-56
lines changed

3 files changed

+5
-56
lines changed

doc/source/contributing.rst

Lines changed: 3 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,6 @@ Create a Python Virtual Development Environment
6464
The following commands initializes and activates a development
6565
environment for Python 3:
6666

67-
.. note::
68-
69-
{kiwi} uses tox to create a devel environment and to run
70-
tests, linters and other tasks in the tox generated environment.
71-
A tox version >= 3.3 is required for this setup process. On your
72-
host a python version >= 3.9 is required for tox to work.
73-
7467
.. code:: shell-session
7568
7669
$ poetry install
@@ -87,47 +80,13 @@ Python sources inside the virtual environment using Poetry:
8780
Running the Unit Tests
8881
----------------------
8982

90-
We use :command:`tox` to run the unit tests. Tox sets up its own
91-
virtualenvs inside the :file:`.tox` directory for multiple Python versions
92-
and should thus **not** be invoked from inside your development virtualenv.
93-
9483
Before submitting your changes via a pull request, ensure that all tests
9584
pass and that the code has the required test coverage via the command:
9685

9786
.. code:: shell-session
9887
99-
$ tox
100-
101-
We also include `pytest-xdist` in the development virtualenv which allows
102-
to run the unit tests in parallel. It is turned off by default but can be
103-
enabled via:
104-
105-
.. code:: shell-session
106-
107-
$ tox -- "-n NUMBER_OF_PROCESSES"
108-
109-
where you can insert an arbitrary number as `NUMBER_OF_PROCESSES` (or a
110-
shell command like `$(nproc)`). Note that the double quotes around `-n
111-
NUMBER_OF_PROCESSES` are required (otherwise :command:`tox` will consume
112-
this command line flag instead of forwarding it to :command:`pytest`).
113-
114-
The previous call would run the unit tests for different Python versions,
115-
check the source code for errors and build the documentation.
116-
117-
If you want to see the available targets, use the option `-l` to let
118-
:command:`tox` print a list of them:
119-
120-
.. code:: shell-session
121-
122-
$ tox -l
123-
124-
To only run a special target, use the `-e` option. The following
125-
example runs the test cases for the Python 3.11 interpreter only:
126-
127-
.. code:: shell-session
128-
129-
$ tox -e unit_py3_11
130-
88+
$ make check
89+
$ make test
13190
13291
Create a Branch for each Feature or Bugfix
13392
------------------------------------------
@@ -159,13 +118,6 @@ Make and commit your changes.
159118
160119
$ git commit -S -a
161120
162-
Run the tests and code style checks. All of these are also performed by
163-
`GitLab CI <https://gitlab.com/kiwi3>`_ when a pull request is created.
164-
165-
.. code:: shell-session
166-
167-
$ tox
168-
169121
Once everything is done, push your local branch to your forked repository and
170122
create a pull request into the upstream repository.
171123

@@ -199,7 +151,7 @@ user documentation and manual pages
199151

200152
.. code:: shell-session
201153
202-
tox -e doc
154+
$ make docs
203155
204156
Document all your classes, methods, their parameters and their types using
205157
the standard `reStructuredText

doc/source/contributing/scripts_testing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ configured on your system. With Podman, the integration tests use :command:`podm
1010
**rootless mode** by default. You can select
1111
:command:`docker` instead by setting the environment variable
1212
``CONTAINER_RUNTIME`` to ``docker``. Then you can run the integration tests via
13-
tox:
13+
the `test_scripts` Makefile target:
1414

1515
.. code:: shell-session
1616
17-
$ tox -e scripts -- -n NUMBER_OF_THREADS
17+
$ sudo make test_scripts
1818
1919
2020
The tests are written using the `pytest-container

pyproject.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ packages = [
2525
include = [
2626
{ path = ".bumpversion.cfg", format = "sdist" },
2727
{ path = ".coverage*", format = "sdist" },
28-
{ path = ".virtualenv.requirements*.txt", format = "sdist" },
29-
{ path = ".virtualenv.dev-requirements.txt", format = "sdist" },
3028
{ path = "setup.cfg", format = "sdist" },
3129
{ path = "doc/source", format = "sdist" },
3230
{ path = "doc/Makefile", format = "sdist" },
@@ -36,7 +34,6 @@ include = [
3634
{ path = "Makefile", format = "sdist" },
3735
{ path = "package", format = "sdist" },
3836
{ path = "test", format = "sdist" },
39-
{ path = "tox.ini", format = "sdist" },
4037
{ path = "kiwi/runtime_checker_metadata.yml", format = "sdist" },
4138
]
4239

0 commit comments

Comments
 (0)