Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pkg/ottl] Add status header to readme #27896

Merged
merged 6 commits into from
Oct 25, 2023

Conversation

TylerHelmuth
Copy link
Member

No description provided.

@TylerHelmuth TylerHelmuth added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Oct 20, 2023
@@ -1,5 +1,13 @@
# OpenTelemetry Transformation Language

| Status | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any thoughts around making this an auto-generated section?

<!-- status autogenerated section -->

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had to modify mdatagen, but its done.

@github-actions github-actions bot added the cmd/mdatagen mdatagen command label Oct 23, 2023
@@ -118,7 +118,8 @@ type DependabotData struct {

func makePriority(status *Status) int {
// not an internal component such as pkg/**, and no distributions:
if len(status.Distributions) == 0 && status.Class != "" {
if (status.Class == "receiver" || status.Class == "processor" || status.Class == "exporter" || status.Class == "connector" || status.Class == "extension" || status.Class == "cmd") &&
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we allow pkg modules now that they can have stability levels?

Copy link
Member Author

@TylerHelmuth TylerHelmuth Oct 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This if statement makes it so the priority of pkg (and any other future group like internal) have their priority set using the switch statement below and not this special case. Without these checks, the pkg type was getting the lowest priority because it wasn't in any distributions. That resulted in make gendependabot removing ottl from the dependabot list.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, thanks. Won't cmd modules hit the same case since they're also not in distributions?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They don't have class set I believe.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should gendependabot be affected by this change?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was bc gendependabot depends on mdatagen and I had to update mdatagen to handle generating a README for a pkg. OTTL is now the first pkg to include a header in the readme and it broke some assumptions in mdatagen and githubgen.

@TylerHelmuth TylerHelmuth merged commit 8a33109 into open-telemetry:main Oct 25, 2023
83 checks passed
@TylerHelmuth TylerHelmuth deleted the ottl-readme-header branch October 25, 2023 20:48
@github-actions github-actions bot added this to the next release milestone Oct 25, 2023
sigilioso pushed a commit to carlossscastro/opentelemetry-collector-contrib that referenced this pull request Oct 27, 2023
jmsnll pushed a commit to jmsnll/opentelemetry-collector-contrib that referenced this pull request Nov 12, 2023
RoryCrispin pushed a commit to ClickHouse/opentelemetry-collector-contrib that referenced this pull request Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cmd/githubgen cmd/mdatagen mdatagen command pkg/ottl Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants