Skip to content

docs: add test maturity model documentation - #4581

Merged
LiliDeng merged 2 commits into
mainfrom
johgeorg/test-maturity-model
Jul 8, 2026
Merged

docs: add test maturity model documentation#4581
LiliDeng merged 2 commits into
mainfrom
johgeorg/test-maturity-model

Conversation

@johnsongeorge-w

Copy link
Copy Markdown
Collaborator

Description

Introducting Test Maturity model for LISA

Related Issue

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Refactoring
  • Documentation update

Checklist

  • Description is filled in above
  • No credentials, secrets, or internal details are included
  • Peer review requested (if not, add required peer reviewers after raising PR)
  • Tests executed and results posted below

Test Validation

Key Test Cases:

N/A
Impacted LISA Features:

N/A
Tested Azure Marketplace Images:

Test Results

N/A

Copilot AI review requested due to automatic review settings July 6, 2026 15:28
@johnsongeorge-w
johnsongeorge-w requested a review from LiliDeng as a code owner July 6, 2026 15:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a new documentation page describing a proposed “Test Maturity Model” concept for LISA test lifecycle/readiness, and links it from the main docs entry points so it’s discoverable.

Changes:

  • Added a new docs/test_maturity_model.rst page describing maturity levels and intended selection behavior.
  • Linked the new page from docs/index.rst (Sphinx toctree) and from README.rst (hosted docs link).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
README.rst Adds a link to the published “Test Maturity Model” docs page.
docs/test_maturity_model.rst Introduces the new Test Maturity Model documentation page.
docs/index.rst Adds the new page to the Sphinx toctree for navigation.

Comment thread docs/test_maturity_model.rst
Comment thread docs/test_maturity_model.rst
@LiliDeng

LiliDeng commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

@johnsongeorge-w Looks good overall. It might be worth adding a bit more detail on a few areas:

Why introduce a dedicated maturity field instead of using tags?
How is precedence handled if both the suite and the test case specify a maturity value?
A simple diagram (or step-by-step description) of the test selection flow, showing how runbook criteria, the implicit stable gate, forceInclude, and forceExclude are applied.

Copilot AI review requested due to automatic review settings July 7, 2026 04:03
@johnsongeorge-w
johnsongeorge-w force-pushed the johgeorg/test-maturity-model branch from cee101d to c09fd07 Compare July 7, 2026 04:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

Comment thread docs/test_maturity_model.rst
Comment thread docs/test_maturity_model.rst
Comment thread docs/test_maturity_model.rst
Comment thread docs/test_maturity_model.rst
- Explain why a dedicated maturity field is used instead of tags
- Document suite vs case maturity precedence with code example
- Add step-by-step test selection flow description
@johnsongeorge-w

Copy link
Copy Markdown
Collaborator Author

@johnsongeorge-w Looks good overall. It might be worth adding a bit more detail on a few areas:

Why introduce a dedicated maturity field instead of using tags? How is precedence handled if both the suite and the test case specify a maturity value? A simple diagram (or step-by-step description) of the test selection flow, showing how runbook criteria, the implicit stable gate, forceInclude, and forceExclude are applied.

Updated.

@LiliDeng
LiliDeng merged commit 80f9ff2 into main Jul 8, 2026
58 checks passed
@LiliDeng
LiliDeng deleted the johgeorg/test-maturity-model branch July 8, 2026 01:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants