From 4bfa2efc57433925bfb6ea18d1ecf9843f8f0c99 Mon Sep 17 00:00:00 2001 From: PabloHiro Date: Fri, 13 Feb 2026 11:44:28 +0100 Subject: [PATCH 1/3] Add testing guide to Sphinx documentation Assisted-By: Claude --- docs/contributing/testing.md | 40 ++++++++++++++++++++++++++++++++++++ docs/index.md | 1 + 2 files changed, 41 insertions(+) create mode 100644 docs/contributing/testing.md diff --git a/docs/contributing/testing.md b/docs/contributing/testing.md new file mode 100644 index 0000000000..23e27891a9 --- /dev/null +++ b/docs/contributing/testing.md @@ -0,0 +1,40 @@ +# Testing Guide + +This document explains how to install dependencies and run tests for awx-plugins. + +## Prerequisites + +- Python 3.11 due to compatibility issues +- [tox](https://tox.wiki/) (recommended) or pip + +## Quick Start + +tox handles dependency installation and test execution automatically: + +```bash +# Install tox +pip install tox + +# Run the full test suite +tox r -e py + +# Run tests for a specific Python version +tox r -e py311 +tox r -e py312 +tox r -e py313 +``` + +## Code Quality Checks + +### Pre-commit Hooks + +```bash +# Install pre-commit +pip install pre-commit + +# Install hooks +pre-commit install + +# Or run pre-commit directly +pre-commit run --all-files +``` diff --git a/docs/index.md b/docs/index.md index 280d078557..cbe05c2ebb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,6 +35,7 @@ changelog Code Of Conduct contributing/guidelines +contributing/testing contributing/communication contributing/security Private unsupported (dev) API autodoc From c3596ab45f1f3e93f88becbf6e38ddab042af1d7 Mon Sep 17 00:00:00 2001 From: PabloHiro Date: Wed, 18 Feb 2026 11:11:03 +0100 Subject: [PATCH 2/3] Address feedback to update testing guidelines --- docs/contributing/testing.md | 28 +++++----------------------- docs/index.md | 2 +- 2 files changed, 6 insertions(+), 24 deletions(-) diff --git a/docs/contributing/testing.md b/docs/contributing/testing.md index 23e27891a9..01f24653de 100644 --- a/docs/contributing/testing.md +++ b/docs/contributing/testing.md @@ -4,37 +4,19 @@ This document explains how to install dependencies and run tests for awx-plugins ## Prerequisites -- Python 3.11 due to compatibility issues -- [tox](https://tox.wiki/) (recommended) or pip +- Python 3 +- [tox](https://tox.wiki/) ## Quick Start tox handles dependency installation and test execution automatically: ```bash -# Install tox -pip install tox - -# Run the full test suite -tox r -e py +# Run the test suite +tox r -e py -qq # Run tests for a specific Python version tox r -e py311 tox r -e py312 tox r -e py313 -``` - -## Code Quality Checks - -### Pre-commit Hooks - -```bash -# Install pre-commit -pip install pre-commit - -# Install hooks -pre-commit install - -# Or run pre-commit directly -pre-commit run --all-files -``` +``` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index cbe05c2ebb..e2a247884f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,9 +35,9 @@ changelog Code Of Conduct contributing/guidelines -contributing/testing contributing/communication contributing/security +contributing/testing Private unsupported (dev) API autodoc ``` From 366e9fdd60dcc50f370b7a3be0ad3c03b1727da8 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 19 Feb 2026 10:43:23 +0000 Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/contributing/testing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/testing.md b/docs/contributing/testing.md index 01f24653de..c6c83cdb23 100644 --- a/docs/contributing/testing.md +++ b/docs/contributing/testing.md @@ -19,4 +19,4 @@ tox r -e py -qq tox r -e py311 tox r -e py312 tox r -e py313 -``` \ No newline at end of file +```