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

Optionally take changes to annotations into account #392

Merged
merged 4 commits into from
Apr 22, 2024

Conversation

guillermocalvo
Copy link
Contributor

Resolves:

Related pull request:

This is an alternative approach, in which changes to annotations will be ignored if option --no-annotations is set.

@siom79
Copy link
Owner

siom79 commented Apr 7, 2024

This PR looks good. But I don't see any integration into the maven plugin nor into the reporting (HTML, stdout, etc.). Are you planning to add this in the future or do you expect me to do this?
Anyhow, thanks for the PR.

@guillermocalvo
Copy link
Contributor Author

This PR looks good. But I don't see any integration into the maven plugin nor into the reporting (HTML, stdout, etc.). Are you planning to add this in the future or do you expect me to do this? Anyhow, thanks for the PR.

Thanks for reviewing my PR. I used an existing configuration option that is already documented and integrated into the CLI as --no-annotations, as well as into the maven plugin as noAnnotations. This PR introduces three new JApiCompatibilityChangeType values that can be added to affected elements when annotations are added, removed or changed. I believe they should be reported as they are, along with the rest of the compatibility changes, both in HTML and stdout. However, I'm more than happy to implement any integrations I may have overlooked. Could you please elaborate on what exactly needs to be done?

siom79 added a commit that referenced this pull request Apr 22, 2024
@siom79 siom79 merged commit 1ede31d into siom79:master Apr 22, 2024
6 checks passed
siom79 added a commit that referenced this pull request Apr 22, 2024
siom79 added a commit that referenced this pull request Apr 22, 2024
@siom79
Copy link
Owner

siom79 commented Apr 22, 2024

Thanks again for the PR. I have added another compatibility change: ANNOTATION_MODIFIED and reworked the code in CompatibilityChanges.java slightly.

During the work I also realized that the implementation of HtmlOutputGenerator did output the wrong value for fields of annotations. This must have been in there for longer, but is fixed now.

@guillermocalvo guillermocalvo deleted the detect-changes-in-annotations branch April 22, 2024 15:39
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.

None yet

2 participants