Skip to content

Commit

Permalink
[chore] Update CONTRIBUTING.md for releasing new component (#32400)
Browse files Browse the repository at this point in the history
**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
The
[cmd/otelcontribcol/components.go](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/cmd/otelcontribcol/components.go)
file is now being generated automatically by `make genotelcontribcol`.
The README needs to properly reflect that users should add new
components to
[`cmd/otelcontribcol/builder-config.yaml`](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/cmd/otelcontribcol/builder-config.yaml)
and then run the make command.

---------

Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>
  • Loading branch information
crobert-1 and codeboten authored Apr 17, 2024
1 parent acef331 commit 707e0e1
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,9 @@ When submitting a component to the community, consider breaking it down into sep
size of this PR is larger than the recommended size consider splitting it in
multiple PRs.
* **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).
binary by updating the `cmd/otelcontribcol/builder-config.yaml` file and running `make genotelcontribcol`.
The component's tests must also be added as a part of its respective `component_type_tests.go` file in the `cmd/otelcontribcol` directory.
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
to the [OpenTelemetry.io registry](https://github.com/open-telemetry/opentelemetry.io#adding-a-project-to-the-opentelemetry-registry).
Expand Down

0 comments on commit 707e0e1

Please sign in to comment.