Skip to content

Commit 7adca80

Browse files
authored
[chore] Add testing requirements for stable components (#12971)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description <!-- Issue number if applicable --> Adds wording regarding testing requirements for stable components. The intent is for the lifecycle tests to be handled via mdatagen. This follows the work done on open-telemetry/opentelemetry-collector-contrib/issues/39543, with which now we have component coverage per component. #### Link to tracking issue Fixes #11867
1 parent 5a9dbb5 commit 7adca80

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/component-stability.md

+10
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,16 @@ Stable components MUST be compatible between minor versions unless critical secu
8787
component owner MUST provide a migration path and a reasonable time frame for users to upgrade. The same rules from beta
8888
components apply to stable when it comes to configuration changes.
8989

90+
#### Testing requirements
91+
92+
Stable components MUST have a test coverage that exceeds the highest between 80% coverage and the
93+
repository-wide minimum. The unit test suite SHOULD cover all configuration options. The coverage
94+
MUST be shown as part of the component documentation.
95+
96+
Stable components SHOULD provide at least one example configuration that works for each stable
97+
signal, and have at least one lifecycle test that tests the component's initialization with a valid
98+
configuration. Said configuration should also be shown in the component documentation.
99+
90100
#### Documentation requirements
91101

92102
Stable components should have a complete set of documentation, including:

0 commit comments

Comments
 (0)