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.

Sign up for GitHub

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

Jump to bottom

Add @Generated annotation to ease configuring tools for static code analysis #315

Closed
jbiscella opened this issue Jul 4, 2023 · 2 comments · Fixed by #323
Closed

Add @Generated annotation to ease configuring tools for static code analysis #315

jbiscella opened this issue Jul 4, 2023 · 2 comments · Fixed by #323
Assignees
@Tenischev
Labels
enhancement New feature or request released

Comments

@jbiscella
Copy link

Reason/Context

Please try answering few of those questions

  • Why we need this improvement?
    Many comnpanies run static code analysis tools to check code quality. Usually is good to have the @generated annotation to programmatically exclude automatically generated code that could not be complaiant, despite still safe to be used.

  • How will this change help?
    Many tools can be configured to exclude classes annotated with https://docs.oracle.com/javase/8/docs/api/javax/annotation/Generated.html

  • What is the motivation?
    See previous answers

Description

Please try answering few of those questions

  • What changes have to be introduced?
    Add to any generated class the @generated annotation

  • Will this be a breaking change?
    I feel not as that package should always be in the classpath in a spring boot project as far as I thing

  • How could it be implemented/designed?
    In the current template classes, add the @generated annotation
@jbiscella jbiscella added the enhancement New feature or request label Jul 4, 2023
@Tenischev Tenischev self-assigned this Jul 28, 2023
@Tenischev Tenischev mentioned this issue Sep 2, 2023
Merged
@Tenischev
Copy link
Member

Tenischev commented Sep 2, 2023 •
edited
Loading

@jbiscella your feedback for PR #323 are welcome.

@asyncapi-bot
Copy link
Contributor

🎉 This issue has been resolved in version 1.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Tenischev Tenischev

Labels
enhancement New feature or request released
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add generated annotation Tenischev/java-spring-template
3 participants
@Tenischev @jbiscella @asyncapi-bot