From 5036ef618f3488058e718b8cab0fa6c7e4522865 Mon Sep 17 00:00:00 2001 From: Martin Hoyer Date: Jul 17 2024 15:48:44 +0000 Subject: Update tmt docs links and subpackage names --- diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index b57db66..7f728a3 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -40,7 +40,7 @@ Tests can be enabled using the *Test Metadata Specification* implemented by the which provides a number of features to efficiently work with tests and is now the recommended way. The *Standard Test Interface* is still supported but has been obsoleted. -* https://tmt.readthedocs.io/en/latest/spec.html[Test Metadata Specification] (recommended) +* https://tmt.readthedocs.io/en/stable/spec.html[Test Metadata Specification] (recommended) * xref:standard-test-interface.adoc[Standard Test Interface] (obsoleted) ==== Gating ==== @@ -181,7 +181,7 @@ If you have questions or would like to get involved: Here are some additional related links: * xref:tmt.adoc[Test Management Tool] ... Fedora CI docs for tmt -* https://tmt.readthedocs.io/en/latest/guide.html[tmt Guide] ... upstream tmt guide +* https://tmt.readthedocs.io/en/stable/guide.html[tmt Guide] ... upstream tmt guide * xref:standard-test-interface.adoc[Standard Test Interface] ... definition of the process * xref:standard-test-roles.adoc[Standard Test Roles] ... set of ansible roles * xref:tests.adoc[Tests] ... executing and adding tests diff --git a/modules/ROOT/pages/share-test-code.adoc b/modules/ROOT/pages/share-test-code.adoc index a77e79e..72d0d9d 100644 --- a/modules/ROOT/pages/share-test-code.adoc +++ b/modules/ROOT/pages/share-test-code.adoc @@ -38,7 +38,7 @@ discover: url: https://src.fedoraproject.org/tests/shell.git ---- -See the https://tmt.readthedocs.io/en/latest/spec/plans.html#fmf[discover] step documentation for more details. +See the https://tmt.readthedocs.io/en/stable/spec/plans.html#fmf[discover] step documentation for more details. === STI === diff --git a/modules/ROOT/pages/tmt.adoc b/modules/ROOT/pages/tmt.adoc index 1ce2db7..9dad853 100644 --- a/modules/ROOT/pages/tmt.adoc +++ b/modules/ROOT/pages/tmt.adoc @@ -4,7 +4,7 @@ The `tmt` tool aims to provide an efficient and comfortable way to create, execute, debug and enable tests in the Continuous Integration. -It implements the https://tmt.readthedocs.io/en/latest/spec.html[Test Metadata Specification] which allows to store all needed test execution data directly within a git repository. +It implements the https://tmt.readthedocs.io/en/stable/spec.html[Test Metadata Specification] which allows to store all needed test execution data directly within a git repository. The same configuration can be used for enabling tests in the Fedora CI, RHEL CI and https://packit.dev/[Packit]. Tests can be easily executed in your preferred environment, e.g. in virtual machine, container or directly on the localhost. @@ -15,14 +15,14 @@ Tests can be easily executed in your preferred environment, e.g. in virtual mach Install tmt on your laptop: sudo dnf install -y tmt # basic features, executing tests on localhost - sudo dnf install -y tmt-all # install all available tmt subpackages including all dependencies + sudo dnf install -y tmt+all # install all available tmt subpackages including all dependencies You can also install selected provision plugins only: - sudo dnf install -y tmt-provision-container # additional dependencies for executing tests in containers - sudo dnf install -y tmt-provision-virtual # support for running tests in a virtual machine using testcloud + sudo dnf install -y tmt+provision-container # additional dependencies for executing tests in containers + sudo dnf install -y tmt+provision-virtual # support for running tests in a virtual machine using testcloud -See the tmt https://tmt.readthedocs.io/en/latest/overview.html#install[install] section for more installation options. +See the tmt https://tmt.readthedocs.io/en/stable/overview.html#install[install] section for more installation options. === Git Repo === @@ -228,7 +228,7 @@ Run tests directly on your localhost: Run tests in a virtual machine: - sudo dnf install -y tmt-provision-virtual + sudo dnf install -y tmt+provision-virtual tmt run Check the documentation to learn more about the tool: @@ -275,7 +275,7 @@ Update the repository url to point to the right place: how: tmt Now you will be able to run tests from the remote repository. -See the https://tmt.readthedocs.io/en/latest/spec/steps.html#discover[discover] step documentation for details. +See the https://tmt.readthedocs.io/en/stable/spec/steps.html#discover[discover] step documentation for details. == Various Hints == @@ -291,7 +291,7 @@ Multiple shell commands can be provided under the `script` attribute as well: - bash --version - bash -c 'echo $((1+1+1))' | grep 3 -See the https://tmt.readthedocs.io/en/latest/spec/plans.html#script[script] method documentation for details. +See the https://tmt.readthedocs.io/en/stable/spec/plans.html#script[script] method documentation for details. === Installing Dependencies === @@ -306,7 +306,7 @@ Required packages can be installed using the `prepare` attribute: execute: script: python3 -c "import M2Crypto" -See the https://tmt.readthedocs.io/en/latest/spec/plans.html#prepare[prepare] step documentation for details. +See the https://tmt.readthedocs.io/en/stable/spec/plans.html#prepare[prepare] step documentation for details. === Multiple Repositories === @@ -359,7 +359,7 @@ See the gating documentation on xref:gating.adoc#_using_multiple_plans[Using Mul Here is an example of a minimal test creation path: - dnf install -y tmt-all + dnf install -y tmt+all git clone https://src.fedoraproject.org/rpms/bash cd bash tmt init -t mini @@ -368,7 +368,7 @@ Here is an example of a minimal test creation path: A slightly extended example with custom test and plan template and executing test directly on the local host: - dnf install -y tmt-all + dnf install -y tmt+all git clone https://src.fedoraproject.org/rpms/bash cd bash tmt init @@ -382,7 +382,7 @@ A slightly extended example with custom test and plan template and executing tes === Virtualization Tips === -In order to safely run tests under a virtual machine started on your laptop you only need to install the `tmt-provision-virtual` package. +In order to safely run tests under a virtual machine started on your laptop you only need to install the `tmt+provision-virtual` package. By default the session connection is used so no other steps should be needed, just execute tests using the `tmt run` command. See the upstream https://tmt.readthedocs.io/en/stable/questions.html#virtualization-tips[Virtualization Tips] for more options. @@ -398,7 +398,7 @@ Example projects with tmt tests: * https://github.com/teemtee/fmf * https://github.com/psss/did -See the tmt https://tmt.readthedocs.io/en/latest/examples.html[examples] page for more inspiration. +See the tmt https://tmt.readthedocs.io/en/stable/examples.html[examples] page for more inspiration. === Links ===