cb7a932951
* Adding SonarQube coverage-related info * README updates * Fix all_green_check workflow * Quality Gate fix * Update sonarcloud workflow, update docs * Add sonarcloud job to all_green_check and update docs accordingly
2.7 KiB
Continuous Integration (CI)
Kubernetes Upstream Testing
GitHub Actions are used to run the CI for the kubernetes.core collection. The workflows used for the CI can be found in the .github/workflows directory.
PR Testing Workflows
The following tests run on every pull request:
| Job | Description | Python Versions | ansible-core Versions |
|---|---|---|---|
| Changelog | Checks for the presence of changelog fragments | 3.12 | devel |
| Linters | Runs black, flake8, isort, yamllint, and ansible-lint on plugins and tests |
3.10 | devel |
| Sanity | Runs ansible sanity checks | See compatibility table below | devel, stable-2.18, stable-2.19, stable-2.20 |
| Unit tests | Executes unit test cases | See compatibility table below | devel, stable-2.16, stable-2.17, stable-2.18, stable-2.19, stable-2.20 |
| Integration | Executes integration test suites using KinD cluster (split across 8 jobs, tests with Turbo mode enabled/disabled) | 3.12 | milestone |
| all_green | Linters (PR only), sanity, units, coverage XML, aggregate gate, and SonarCloud scan (same-repo PR / push when org secret is set) | (see jobs) | (see jobs) |
Note: Integration tests require a KinD (Kubernetes in Docker) cluster and test both with Turbo mode enabled and disabled.
Python Version Compatibility by ansible-core Version
These are outlined in the collection's tox.ini file (envlist) and GitHub Actions workflow exclusions.
| ansible-core Version | Sanity Tests | Unit Tests |
|---|---|---|
| devel | 3.12, 3.13, 3.14 | 3.12, 3.13 |
| stable-2.20 | 3.12, 3.13, 3.14 | 3.12, 3.13, 3.14 |
| stable-2.19 | 3.11, 3.12, 3.13 | 3.11, 3.12, 3.13 |
| stable-2.18 | 3.11, 3.12, 3.13 | 3.11, 3.12, 3.13 |
| stable-2.17 | 3.10, 3.11, 3.12 | 3.10, 3.11, 3.12 |
| stable-2.16 | 3.10, 3.11 | 3.10, 3.11 |
SonarCloud
SonarCloud analysis runs from all_green_check.yaml via the sonarcloud job, which calls sonarcloud.yml (workflow_call) after the all_green gate and coverage succeed. The reusable workflow checks out the PR head or push SHA, downloads the coverage artifact, and runs the pinned SonarSource scan action. Same-repo pull_request and push only (fork PRs skip Sonar when the org secret is unavailable). Details: SONARCLOUD.md.