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

Fix security warning. #643

Merged
merged 2 commits into from
Dec 5, 2019
Merged

Fix security warning. #643

merged 2 commits into from
Dec 5, 2019

Conversation

yaohaizh
Copy link

@yaohaizh yaohaizh commented Nov 6, 2019

Fix security alerts on the github repo main page.

<!-- Checks for Javadoc comments. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html -->

<module name="JavadocMethod">
<property name="scope" value="public"/>
<property name="allowMissingParamTags" value="true"/>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this needed?

Copy link
Author

Choose a reason for hiding this comment

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

There are too many warnings about violation of this rule. Given this, I suppress this temporarily. If the security work is not urgent, I would like to fix the issue on generator and then on the fluent code base.

@@ -173,8 +175,6 @@
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<module name="FileContentsHolder"/>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this removed? From the docs it seems this is needed if used in conjunction with SuppressWithNearbyCommentFilter: https://checkstyle.sourceforge.io/version/6.18/config_filters.html#SuppressWithNearbyCommentFilter

Usage: This filter only works in conjunction with a FileContentsHolder, since that check makes the suppression comments in the Java files available. A configuration that includes this filter must configure FileContentsHolder as a child module of TreeWalker.

Copy link
Author

Choose a reason for hiding this comment

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

According to this release note: https://checkstyle.sourceforge.io/releasenotes.html#Release_8.2, this is not necessary again after version 8.2. Here we use 8.24 to make it consist with the latest setup on the azure-sdk-for-java-repo.

@jianghaolu jianghaolu merged commit 0ecebe2 into master Dec 5, 2019
@yaohaizh yaohaizh deleted the fix_security branch December 11, 2019 02:31
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.

2 participants