Document running tox within a Docker container #2923

31z4 · 2023-02-10T05:18:17Z

Created this PR to continue work on #1035. The idea is to mention 31z4/tox Docker image in the docs to gather more feedback from users. What do you guys think? Is it OK to refer to the current version of the image? Or moving the image under the tox-dev organisation or making it official would be a blocker?

Thanks for contribution

Please, make sure you address all the checklists (for details on how see
development documentation)!

ran the linter to address style issues (tox -e fix)
wrote descriptive pull request text
ensured there are test(s) validating the fix
added news fragment in docs/changelog folder
updated/extended the documentation

for more information, see https://pre-commit.ci

gaborbernat · 2023-02-10T05:55:06Z

docs/faq.rst

+
+.. code-block:: Dockerfile
+
+    FROM 31z4/tox


Could we create a tox-dev or tox org instead to host under? You can be one of it's owner's 😊

Yes I think it makes sense. Although, if we aim to make the image "official" maybe it's better to work towards this right now. This way we can save some maintenance efforts. Because we don't have to deprecate tox-dev/tox in favour of official tox. And also users don't have to migrate from the deprecated image to the official one.

Some benefits of an official image that I'd like to highlight:

Automated multi-arch builds.

Automated periodic re-builds when a base image is updated.

Better structured docs and build artefacts (e.g.. https://github.com/docker-library/repo-info/tree/master/repos/zookeeper).

Yeah let's make it so. What do you need from me to get there?

I guess nothing at this point. I'll make some usability changes to the image to conform with https://github.com/docker-library/official-images#consistency. And then will work on PRs to https://github.com/docker-library/official-images and https://github.com/docker-library/docs.

gaborbernat · 2023-02-10T05:55:51Z

docs/faq.rst

+
+.. code-block:: shell
+
+    docker run -v `pwd`:/home/tox/tests -it --rm 31z4/tox run-parallel -e black,py311


Would prefer to mount the project under the /w folder, personal preference 😅

That's possible too ☺️ But you have to specify the workdir in that case (-w /w):

docker run -v `pwd`:/w -w /w -it --rm 31z4/tox run-parallel -e black,py311

I can change image workdir from /home/tox/tests to something more concise, like /tests maybe. I agree that /home/tox/tests might be too long to type 😅

I'd make/w the default, concise better 😅

@31z4 ping on this?

I've been pretty busy recently. Hopefully will get a chance to work on the official image later this month. In the meantime https://github.com/31z4/tox-docker should be good enough for production already.

This PR contains the following updates: | Package | Type | Update | Change | Pending | |---|---|---|---|---| | [tox](https://togithub.com/tox-dev/tox) ([changelog](https://tox.wiki/en/latest/changelog.html)) | dev | minor | `4.4.8` -> `4.5.1` | `4.6.0` (+1) | --- ### Release Notes <details> <summary>tox-dev/tox</summary> ### [`v4.5.1`](https://togithub.com/tox-dev/tox/releases/tag/4.5.1): Test Trusted Publisher [Compare Source](https://togithub.com/tox-dev/tox/compare/4.5.0...4.5.1) ### [`v4.5.0`](https://togithub.com/tox-dev/tox/releases/tag/4.5.0) [Compare Source](https://togithub.com/tox-dev/tox/compare/4.4.12...4.5.0) #### What's Changed - Bump deps and tools by [@gaborbernat](https://togithub.com/gaborbernat) in [tox-dev/tox#2987 - git: Ignore the .lock file for demo_pkg_inline by [@hroncok](https://togithub.com/hroncok) in [tox-dev/tox#2988 - Add FAQ entry on how to test against EOL Python versions by [@jugmac00](https://togithub.com/jugmac00) in [tox-dev/tox#2991 - Feature: suppress step timings for verbosity=1 [#2891](https://togithub.com/tox-dev/tox/issues/2891) by [@nedbat](https://togithub.com/nedbat) in [tox-dev/tox#2992 **Full Changelog**: tox-dev/tox@4.4.12...4.5.0 ### [`v4.4.12`](https://togithub.com/tox-dev/tox/releases/tag/4.4.12) [Compare Source](https://togithub.com/tox-dev/tox/compare/4.4.11...4.4.12) #### What's Changed - Avoid race conditions in tests using the demo_pkg_inline fixture by [@hroncok](https://togithub.com/hroncok) in [tox-dev/tox#2986 - Bump deps and tools by [@gaborbernat](https://togithub.com/gaborbernat) in [tox-dev/tox#2981 **Full Changelog**: tox-dev/tox@4.4.11...4.4.12 ### [`v4.4.11`](https://togithub.com/tox-dev/tox/releases/tag/4.4.11) [Compare Source](https://togithub.com/tox-dev/tox/compare/4.4.10...4.4.11) #### What's Changed - Allow plugins to set `tox_root` by [@kdestin](https://togithub.com/kdestin) in [tox-dev/tox#2978 #### New Contributors - [@kdestin](https://togithub.com/kdestin) made their first contribution in [tox-dev/tox#2978 **Full Changelog**: tox-dev/tox@4.4.10...4.4.11 ### [`v4.4.10`](https://togithub.com/tox-dev/tox/releases/tag/4.4.10) [Compare Source](https://togithub.com/tox-dev/tox/compare/4.4.9...4.4.10) #### What's Changed - Bump deps and tools by [@gaborbernat](https://togithub.com/gaborbernat) in [tox-dev/tox#2976 - Fix `tox_root` propagation to `work_dir` by [@Tbruno25](https://togithub.com/Tbruno25) in [tox-dev/tox#2962 #### New Contributors - [@Tbruno25](https://togithub.com/Tbruno25) made their first contribution in [tox-dev/tox#2962 **Full Changelog**: tox-dev/tox@4.4.9...4.4.10 ### [`v4.4.9`](https://togithub.com/tox-dev/tox/releases/tag/4.4.9) [Compare Source](https://togithub.com/tox-dev/tox/compare/4.4.8...4.4.9) #### What's Changed - Added python 3.11 by [@ElBe-Plaq](https://togithub.com/ElBe-Plaq) in [tox-dev/tox#2964 - Document running tox within a Docker container by [@31z4](https://togithub.com/31z4) in [tox-dev/tox#2923 - Correct Docker image working dir by [@31z4](https://togithub.com/31z4) in [tox-dev/tox#2965 - Avoid UnicodeDecodeError from command output by [@masenf](https://togithub.com/masenf) in [tox-dev/tox#2970 - Bump pypa/gh-action-pypi-publish from 1.8.3 to 1.8.5 by [@dependabot](https://togithub.com/dependabot) in [tox-dev/tox#2971 #### New Contributors - [@ElBe-Plaq](https://togithub.com/ElBe-Plaq) made their first contribution in [tox-dev/tox#2964 - [@31z4](https://togithub.com/31z4) made their first contribution in [tox-dev/tox#2923 **Full Changelog**: tox-dev/tox@4.4.8...4.4.9 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box  Co-authored-by: descope[bot] <descope[bot]@users.noreply.github.com>

Document running tox within a Docker container

0f7fe1d

31z4 requested a review from gaborbernat as a code owner February 10, 2023 05:18

psf-chronographer bot added the bot:chronographer:provided label Feb 10, 2023

[pre-commit.ci] auto fixes from pre-commit.com hooks

bac90ca

for more information, see https://pre-commit.ci

gaborbernat reviewed Feb 10, 2023

View reviewed changes

31z4 marked this pull request as draft February 14, 2023 05:45

31z4 mentioned this pull request Mar 24, 2023

Add tox docker-library/official-images#14328

Open

10 tasks

gaborbernat marked this pull request as ready for review March 30, 2023 14:02

gaborbernat merged commit affd839 into tox-dev:main Mar 30, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document running tox within a Docker container #2923

Document running tox within a Docker container #2923

31z4 commented Feb 10, 2023

gaborbernat Feb 10, 2023

31z4 Feb 10, 2023

gaborbernat Feb 10, 2023

31z4 Feb 13, 2023

gaborbernat Feb 10, 2023

31z4 Feb 10, 2023

gaborbernat Feb 10, 2023

gaborbernat Mar 12, 2023

31z4 Mar 14, 2023


		.. code-block:: shell

		docker run -v `pwd`:/home/tox/tests -it --rm 31z4/tox run-parallel -e black,py311

Document running tox within a Docker container #2923

Document running tox within a Docker container #2923

Conversation

31z4 commented Feb 10, 2023

Thanks for contribution

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment