From 7adca809a60fad65a71063f6651f231466a29844 Mon Sep 17 00:00:00 2001 From: Pablo Baeyens Date: Wed, 7 May 2025 10:15:47 +0200 Subject: [PATCH] [chore] Add testing requirements for stable components (#12971) #### Description 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 --- docs/component-stability.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/component-stability.md b/docs/component-stability.md index 6b036f32f8..9fc1295e88 100644 --- a/docs/component-stability.md +++ b/docs/component-stability.md @@ -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: