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

Add functionality to generate API changes #4285

Merged
merged 4 commits into from
Oct 6, 2021
Merged

Conversation

iNikem
Copy link
Contributor

@iNikem iNikem commented Oct 4, 2021

Closes #4116

Almost verbatim copy from opentelemetry-java repo

@@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.
Copy link
Contributor

Choose a reason for hiding this comment

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

does this mean that this has no non-internal public classes/methods?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This means that it did not change since the last release. At least I read id this way.

Copy link
Contributor

Choose a reason for hiding this comment

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

Was this marked stable in a previous release, then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, why?

Copy link
Contributor

Choose a reason for hiding this comment

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

The gradle code is supposed to generate the full API in the case where there is no previously published stable release. If it's not doing that, then there might be something amiss without how the porting over from the java repo happened.

Copy link
Contributor

Choose a reason for hiding this comment

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

Having a baseline of the API can be useful when looking at the first official stable release, as a documentation of the actual API that is now stable, rather than just seeing "no changes".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see. And under which folder such full API listing should live? I suspect not under "current vs latest"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed my support for unstable versions and also removed this diffs, as they don't make sense for now.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see. And under which folder such full API listing should live? I suspect not under "current vs latest"?

I think it would belong there if the 'current' has been marked stable in the current snapshot. It's a description of what you're preparing to release as a new stable API.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see. And under which folder such full API listing should live? I suspect not under "current vs latest"?

I think it would belong there if the 'current' has been marked stable in the current snapshot. It's a description of what you're preparing to release as a new stable API.

Got it, makes sense. So we will add that API list when we are ready to declare it stable.

Copy link
Member

@trask trask left a comment

Choose a reason for hiding this comment

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

I see. And under which folder such full API listing should live? I suspect not under "current vs latest"?

I'm good with whatever you decide

@iNikem iNikem merged commit c283746 into open-telemetry:main Oct 6, 2021
@iNikem iNikem deleted the japicmp branch October 6, 2021 06:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Track api diff reports for soonish-to-be-stable artifacts
4 participants