-
Notifications
You must be signed in to change notification settings - Fork 51
Introduce Custom Build Analyzer for Hazelcast .Net Client #956
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
Conversation
gbarnett-hz
left a comment
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.
LGTM - though I would hold off merging until it's actually used.
What's the empty AnalyzerReleases.Unshipped.md for?
|
Thanks @gbarnett-hz. It's used for version logging. The analyzer dependency requires these files before making the rule available. It's a kind a check point before making the rules available and for version history. The new added rule is reflected to the unshipped file and moved to shipped file manually. Also, similar approach exists on the client as well. Public APIs are inserted to unshipped file by the IDE and it prevents the release if they are not moved to shipped file manually. It's a nice reminder checking the public APIs one last time. The rule is disabled for now, so that we can merge the PR, IMO. We can enable it when we have resource to drain warnings. Otherwise, opening PR diverges from master by time :| |
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.
Can you update the documentation or README about how a developer can try this rule since it is not on by default? The steps he/she needs to try it?
|
PR closed by Hazelcast automation as no activity (>3 months). Please reopen with comments, if necessary. Thank you for using Hazelcast and your valuable contributions |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #956 +/- ##
=============================
=============================
☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
I believe we need a custom analyzers for more consistent development quality. Introduced the
Hazelcast.Net.BuildAnalyzerswith an initial rule. The project is an internal tool. It runs on compile time and not part of the release. Currently, disabled the analyzer since the first rule which checks the all public APIs whether they haveNotNullorMayBeNullattributes. Since the attributes are not used widely enough, triggers a lot of warnings. When I find time, I'll fix the warnings with another PR.