[chore] Update contributing components guidelines #20881
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TylerHelmuth
added
the
Skip Changelog
Foresight Summary
View More Details⭕ changelog workflow has finished in 7 seconds (2 minutes 8 seconds less than
|
| Job | Failed Steps | Tests | |
|---|---|---|---|
| changelog | - 🔗 | N/A | See Details |
⭕ build-and-test-windows workflow has finished in 9 seconds (30 minutes 34 seconds less than main branch avg.) and finished at 12th Apr, 2023.
| Job | Failed Steps | Tests | |
|---|---|---|---|
| windows-unittest-matrix | - 🔗 | N/A | See Details |
| windows-unittest | - 🔗 | N/A | See Details |
✅ telemetrygen workflow has finished in 1 minute 19 seconds and finished at 12th Apr, 2023.
| Job | Failed Steps | Tests | |
|---|---|---|---|
| build-dev | - 🔗 | N/A | See Details |
| publish-latest | - 🔗 | N/A | See Details |
| publish-stable | - 🔗 | N/A | See Details |
✅ check-links workflow has finished in 1 minute 53 seconds (⚠️ 55 seconds more than main branch avg.) and finished at 12th Apr, 2023.
| Job | Failed Steps | Tests | |
|---|---|---|---|
| changed files | - 🔗 | N/A | See Details |
| check-links | - 🔗 | N/A | See Details |
✅ prometheus-compliance-tests workflow has finished in 3 minutes 12 seconds (3 minutes 13 seconds less than main branch avg.) and finished at 12th Apr, 2023.
| Job | Failed Steps | Tests | |
|---|---|---|---|
| prometheus-compliance-tests | - 🔗 | N/A | See Details |
✅ e2e-tests workflow has finished in 13 minutes 54 seconds and finished at 12th Apr, 2023.
| Job | Failed Steps | Tests | |
|---|---|---|---|
| kubernetes-test (v1.26.0) | - 🔗 | N/A | See Details |
| kubernetes-test (v1.25.3) | - 🔗 | N/A | See Details |
| kubernetes-test (v1.24.7) | - 🔗 | N/A | See Details |
| kubernetes-test (v1.23.13) | - 🔗 | N/A | See Details |
✅ load-tests workflow has finished in 14 minutes 33 seconds (⚠️ 4 minutes 1 second more than main branch avg.) and finished at 12th Apr, 2023.
| Job | Failed Steps | Tests | |
|---|---|---|---|
| setup-environment | - 🔗 | N/A | See Details |
| loadtest (TestIdleMode) | - 🔗 | N/A | See Details |
| loadtest (TestBallastMemory|TestLog10kDPS) | - 🔗 | N/A | See Details |
| loadtest (TestMetric10kDPS|TestMetricsFromFile) | - 🔗 | N/A | See Details |
| loadtest (TestMetricResourceProcessor|TestTrace10kSPS) | - 🔗 | N/A | See Details |
| loadtest (TestTraceNoBackend10kSPS|TestTrace1kSPSWithAttrs) | - 🔗 | N/A | See Details |
| loadtest (TestTraceBallast1kSPSWithAttrs|TestTraceBallast1kSPSAddAttrs) | - 🔗 | N/A | See Details |
| loadtest (TestTraceAttributesProcessor) | - 🔗 | N/A | See Details |
✅ build-and-test workflow has finished in 42 minutes 16 seconds and finished at 12th Apr, 2023.
| Job | Failed Steps | Tests | |
|---|---|---|---|
| govulncheck | - 🔗 | N/A | See Details |
| setup-environment | - 🔗 | N/A | See Details |
| check-codeowners | - 🔗 | N/A | See Details |
| check-collector-module-version | - 🔗 | N/A | See Details |
| lint-matrix (receiver-0) | - 🔗 | N/A | See Details |
| lint-matrix (receiver-1) | - 🔗 | N/A | See Details |
| lint-matrix (processor) | - 🔗 | N/A | See Details |
| lint-matrix (exporter) | - 🔗 | N/A | See Details |
| lint-matrix (extension) | - 🔗 | N/A | See Details |
| lint-matrix (connector) | - 🔗 | N/A | See Details |
| lint-matrix (internal) | - 🔗 | N/A | See Details |
| lint-matrix (other) | - 🔗 | N/A | See Details |
| checks | - 🔗 | N/A | See Details |
| unittest-matrix (1.20, receiver-0) | - 🔗 | N/A | See Details |
| unittest-matrix (1.20, receiver-1) | - 🔗 | N/A | See Details |
| unittest-matrix (1.20, processor) | - 🔗 | N/A | See Details |
| unittest-matrix (1.20, exporter) | - 🔗 | N/A | See Details |
| unittest-matrix (1.20, extension) | - 🔗 | N/A | See Details |
| unittest-matrix (1.20, connector) | - 🔗 | N/A | See Details |
| unittest-matrix (1.20, internal) | - 🔗 | N/A | See Details |
| unittest-matrix (1.20, other) | - 🔗 | N/A | See Details |
| unittest-matrix (1.19, receiver-0) | - 🔗 | N/A | See Details |
| unittest-matrix (1.19, receiver-1) | - 🔗 | N/A | See Details |
| unittest-matrix (1.19, processor) | - 🔗 | N/A | See Details |
| unittest-matrix (1.19, exporter) | - 🔗 | N/A | See Details |
| unittest-matrix (1.19, extension) | - 🔗 | N/A | See Details |
| unittest-matrix (1.19, connector) | - 🔗 | N/A | See Details |
| unittest-matrix (1.19, internal) | - 🔗 | N/A | See Details |
| unittest-matrix (1.19, other) | - 🔗 | N/A | See Details |
| correctness-metrics | - 🔗 | N/A | See Details |
| correctness-traces | - 🔗 | N/A | See Details |
| integration-tests | - 🔗 | N/A | See Details |
| build-examples | - 🔗 | N/A | See Details |
| lint | - 🔗 | N/A | See Details |
| unittest (1.20) | - 🔗 | N/A | See Details |
| unittest (1.19) | - 🔗 | N/A | See Details |
| cross-compile (darwin, amd64) | - 🔗 | N/A | See Details |
| cross-compile (darwin, arm64) | - 🔗 | N/A | See Details |
| cross-compile (linux, 386) | - 🔗 | N/A | See Details |
| cross-compile (linux, amd64) | - 🔗 | N/A | See Details |
| cross-compile (linux, arm) | - 🔗 | N/A | See Details |
| cross-compile (linux, arm64) | - 🔗 | N/A | See Details |
| cross-compile (linux, ppc64le) | - 🔗 | N/A | See Details |
| cross-compile (windows, 386) | - 🔗 | N/A | See Details |
| cross-compile (windows, amd64) | - 🔗 | N/A | See Details |
| build-package (deb) | - 🔗 | N/A | See Details |
| build-package (rpm) | - 🔗 | N/A | See Details |
| windows-msi | - 🔗 | N/A | See Details |
| publish-check | - 🔗 | N/A | See Details |
| publish-stable | - 🔗 | N/A | See Details |
| publish-dev | - 🔗 | N/A | See Details |
| rotate-milestone | - 🔗 | N/A | See Details |
*You can configure Foresight comments in your organization settings page.
jpkrohling
reviewed
Apr 12, 2023
| * **Last PR** should mark the new component as `Alpha` stability and add it to the `cmd/otelcontribcol` | ||
| binary by updating the `cmd/otelcontribcol/components.go` file. The component must be enabled | ||
| only after sufficient testing and only when it meets [`Alpha` stability requirements](https://github.com/open-telemetry/opentelemetry-collector#alpha). | ||
| * Once a new component has been added to the executable, please add the component |
There was a problem hiding this comment.
Is this needed? I thought we got updates for free there?
There was a problem hiding this comment.
Not free (at least that I'm aware of). I believe this file needs manually updated: https://github.com/open-telemetry/opentelemetry.io/tree/main/data/registry.
Related docs: https://opentelemetry.io/ecosystem/registry/adding/
There was a problem hiding this comment.
You are right. I saw some new components there that I was confident the author didn't add and thought there was some automatic process involved. Apparently, @svrnm has been doing this:
There was a problem hiding this comment.
We have a semi automatic process for adding to (and removing from) the registry. I run it monthly (or bi-monthly) to scan most repos for new components.
There was a problem hiding this comment.
@jpkrohling Want to keep the line anyways?
There was a problem hiding this comment.
If we do not expect the developers of new components to send the change to the registry, I would remove it.
There was a problem hiding this comment.
I am ok with expecting them to make the change.
TylerHelmuth
force-pushed
the
adjust-new-component-guide
branch
from
950c2b6 to
7a4085f
Compare
atoulme
approved these changes
Apr 12, 2023
codeboten
approved these changes
Apr 12, 2023
mx-psi
approved these changes
Apr 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Updates CONTRIBUTING.md's
New Componentsection to reflect most recent new component guidelines. Change made in parallel with open-telemetry/opentelemetry-collector#7530.Link to tracking Issue:
Related to discussion in #20853