open-telemetry
/
opentelemetry-collector
mirror of https://github.com/open-telemetry/opentelemetry-collector.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[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
This commit is contained in:
Pablo Baeyens 2025-05-07 10:15:47 +02:00 committed by GitHub
parent 5a9dbb5b02
commit 7adca809a6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/component-stability.md
View File

@ -87,6 +87,16 @@ Stable components MUST be compatible between minor versions unless critical secu
component owner MUST provide a migration path and a reasonable time frame for users to upgrade. The same rules from beta
components apply to stable when it comes to configuration changes.
#### Testing requirements
Stable components MUST have a test coverage that exceeds the highest between 80% coverage and the
repository-wide minimum. The unit test suite SHOULD cover all configuration options. The coverage
MUST be shown as part of the component documentation.
Stable components SHOULD provide at least one example configuration that works for each stable
signal, and have at least one lifecycle test that tests the component's initialization with a valid
configuration. Said configuration should also be shown in the component documentation.
#### Documentation requirements
Stable components should have a complete set of documentation, including: