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

Regression on code changes and message changes #68

Open
rnveach opened this issue Aug 5, 2017 · 0 comments
Open

Regression on code changes and message changes #68

rnveach opened this issue Aug 5, 2017 · 0 comments
Assignees

Comments

@rnveach
Copy link
Member

rnveach commented Aug 5, 2017

Identified in PR checkstyle/checkstyle#4903 ,

If a PR makes changes to Check logic and changes to a existing message, normal regression will display too many differences as all will be centered around change in message and it will be impossible/hard to discern if any where from code changes.

In this situation, we should force check's message to a specific message for both base and patch runs so only the differences in the code is examined.
Example of configuration for the PR mentioned:

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<module name="Checker">
    <property name="charset" value="UTF-8"/>
    <property name="severity" value="warning"/>
    <property name="haltOnException" value="false"/>

    <module name="TreeWalker">
        <module name="SummaryJavadoc">
            <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
            <message key="summary.first.sentence" value="First sentence of Javadoc is missing an ending period."/>
        </module>
    </module>
</module>

Notice the message is only for summary.first.sentence as that was what was modified in the PR.

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

No branches or pull requests

2 participants