-
Notifications
You must be signed in to change notification settings - Fork 533
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
fix(instrumentation-aws-lambda): add 'lint:semconv-deps' #2569
base: main
Are you sure you want to change the base?
fix(instrumentation-aws-lambda): add 'lint:semconv-deps' #2569
Conversation
This adds a lint step that checks that packages in the workspace are following our 'rule' that uses of the semconv pkg 'incubating' entry-point should *pin* the '@opentelemetry/semantic-conventions' dep. This is because (though rare) the incubating/unstable semconv exports can have breaking changes in minors. Refs: open-telemetry#2549 (comment) Refs: open-telemetry/opentelemetry-js#5182
Currently there is one package that is breaking this rule:
I'll update that dep in a commit on this PR. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2569 +/- ##
=======================================
Coverage 90.75% 90.75%
=======================================
Files 169 169
Lines 8018 8018
Branches 1632 1632
=======================================
Hits 7277 7277
Misses 741 741 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should instrumentation-aws-lambda
be removed from commit message since the script is global?
This includes a change to instrumentation-aws-lambda's package.json#dependencies for which there should be a new version of this package, so I think it should stay. IIRC keeping it in the commit title is what gets the release process to notice that there should be a new version of this package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving update to instrumentation-aws-lambda
's package.json.
Given the decision here: open-telemetry/opentelemetry-js#5182 (comment) |
This adds a lint step that checks that packages in the workspace
are following our 'rule' that uses of the semconv pkg 'incubating'
entry-point should pin the '@opentelemetry/semantic-conventions'
dep. This is because (though rare) the incubating/unstable
semconv exports can have breaking changes in minors.
Refs: #2549 (comment)
Refs: open-telemetry/opentelemetry-js#5182
That "rule" (to pin the semconv package dep when using the incubating entry-point) is the concensus from discussion on open-telemetry/opentelemetry-js#5182
I'm proposing this extra lint step (added to
npm run lint
) that will help check that this rule is followed.