-
Notifications
You must be signed in to change notification settings - Fork 652
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
Add public symbols checker script #1816
Conversation
77f52ee
to
d0d873d
Compare
This is awesome. It'd be even more amazing if we had a CI script that posted the output from this command as a comment to the PR. That'd be super useful. |
Hm, good idea, let me see if I can implement it 💪 |
a1ca414
to
54135b0
Compare
Co-authored-by: Aaron Abbott <[email protected]>
Co-authored-by: Aaron Abbott <[email protected]>
@ocelotl please take a look at the lint failures. |
Checking, @codeboten... |
I am marking this PR as draft while I fix @aabmass comments ✌️ |
Comments have been addressed. I understand that new features can be added to make this checker better and smarter, but I suggest we start with this now. This way we at least have some protection for our public API. ✌️ Thank you all for your comments and ideas 👍 |
Description
This adds a tool that can be called with
tox -e public-symbols-check
and will show the user what public symbols are being added by a branch (as compared againstmain
). For example, for this branch, the tool produces this output:Fixes #1815
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Does This PR Require a Contrib Repo Change?
Answer the following question based on these examples of changes that would require a Contrib Repo Change:
The OTel specification has changed which prompted this PR to update the method interfaces of
opentelemetry-api/
oropentelemetry-sdk/
The method interfaces of
test/util
have changedScripts in
scripts/
that were copied over to the Contrib repo have changedConfiguration files that were copied over to the Contrib repo have changed (when consistency between repositories is applicable) such as in
pyproject.toml
isort.cfg
.flake8
When a new
.github/CODEOWNER
is addedMajor changes to project information, such as in:
README.md
CONTRIBUTING.md
Yes. - Link to PR:
No.
Checklist: