[libvirt PATCH v2 00/10] docs: Expand documentation on the CI/testing topic

Erik Skultety eskultet at redhat.com
Thu Jul 14 15:34:25 UTC 2022


This series was inspired by QEMU's documentation on CI and focuses on the
following:
- adds documentation on how to add a custom runner to the libvirt project or
  its fork, mainly in context of running functional testing
- replaces the old 'testsuites' article with a more detailed landing page
describing different types of testing available in libvirt
- updates the TCK documentation with details on how TCK should be installed
  and used nowadays

Since v1:
- described the --force argument with TCK usage
- moved the article about adding  new platforms to libvirt-ci and linked it
  from our docs
    -> corresponding MR here: https://gitlab.com/libvirt/libvirt-ci/-/merge_requests/295
    -> ^the MR must merged **FIRST**!

- moved Podman prerequistes for local container builds before Docker

Here's a fresh website pipeline with artifacts:
    https://gitlab.com/eskultety/libvirt/-/jobs/2722840726

Erik Skultety (10):
  docs: Move the CI dashboard to its own RST module
  docs: Provide more information about the TCK test suite
  docs: Provide an article on how to add a custom runner to the project
  docs: Provide an article on testing
  docs: Replace testsuites article with the new 'testing' article
  docs: Drop the testsuites article
  docs: Change the CI headline from "CI Testing" to "CI"
  docs: ci: Add info about the two major types of jobs our CI runs
  docs: ci: Add a section on how to add a new platform to libvirt CI
  docs: ci: Add a brief section on how to run the CI workload locally

 docs/ci-dashboard.rst | 216 ++++++++++++++++++++++++++++++++++++++
 docs/ci-runners.rst   |  86 +++++++++++++++
 docs/ci.rst           | 237 ++++++------------------------------------
 docs/docs.rst         |  10 +-
 docs/meson.build      |   4 +-
 docs/testing.rst      | 172 ++++++++++++++++++++++++++++++
 docs/testsuites.rst   |  37 -------
 docs/testtck.rst      |  99 ++++++++++++++++--
 8 files changed, 602 insertions(+), 259 deletions(-)
 create mode 100644 docs/ci-dashboard.rst
 create mode 100644 docs/ci-runners.rst
 create mode 100644 docs/testing.rst
 delete mode 100644 docs/testsuites.rst

-- 
2.36.1



More information about the libvir-list mailing list