From 1a052ec8df7b59373001324b8851756214966afc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Goinvic?= Date: Fri, 27 Mar 2026 11:32:04 +0100 Subject: [PATCH] Fix tool readme --- newsfragments/1196.internal.md | 1 + tests/README.md | 27 +++++++++++++++++++++++++-- 2 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 newsfragments/1196.internal.md diff --git a/newsfragments/1196.internal.md b/newsfragments/1196.internal.md new file mode 100644 index 00000000..12d5456f --- /dev/null +++ b/newsfragments/1196.internal.md @@ -0,0 +1 @@ +CI: Publish ESS tests as a python package for use in external projects and developers environments. diff --git a/tests/README.md b/tests/README.md index 38e900f0..9b26ec97 100644 --- a/tests/README.md +++ b/tests/README.md @@ -19,14 +19,37 @@ The ESS Community Integration Tests project is designed to facilitate the testin - Docker - [k3d](https://k3d.io/stable/) - [Helm](https://helm.sh/docs/intro/install) +- Optional: [uv](https://docs.astral.sh/uv/getting-started/installation/) to install from git ## Installation -Either using `uv` or `pipx`: ```sh pipx install ess-community-integration-tests -uv tool install ess-community-integration-tests +uvx ess-community-integration-tests +``` + +You can also install it from the git repository : + +```sh +# You can also use any ESS Community version +VERSION=main +uvx git+https://github.com/element-hq/ess-helm.git@$VERSION$#subdirectory=tests +``` + +Example: + +```sh +VERSION=main +uvx git+https://github.com/element-hq/ess-helm.git@$VERSION#subdirectory=tests + Updated https://github.com/element-hq/ess-helm.git (d6d33a7f7051a0b6bbdcc609a059ae328feee269) + Built ess-community-integration-tests @ git+https://github.com/element-hq/ess-helm.git@d6d33a7f7051a0b6bbdcc609a059ae328feee269#subdirectory=tests +Installed 60 packages in 5ms +An executable named `ess-community-integration-tests` is not provided by package `ess-community-integration-tests`. +The following executables are available: +- collect-ess-logs +- pytest-ess +- setup-ess-cluster ``` ## Usage