Skip to content

Commit

Permalink
Update from extractor auto execution
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 10, 2024
1 parent ad60d02 commit aa4ff48
Show file tree
Hide file tree
Showing 9 changed files with 955 additions and 0 deletions.
29 changes: 29 additions & 0 deletions JavadocParagraph/Example3/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Example3 Configs

Bellow are two options that will do the same but use different versions
of github actions in checkstyle repository.


### Option 1
Trigger report generation by comment in Pull Request:
```
Github, generate report for JavadocParagraph/Example3
```

### Option 2

Paste below given to PR description to use such test configs:
```
Report label: JavadocParagraph/Example3
Diff Regression config: https://raw.githubusercontent.com/checkstyle/test-configs/main/JavadocParagraph/Example3/config.xml
Diff Regression projects: https://raw.githubusercontent.com/checkstyle/test-configs/main/JavadocParagraph/Example3/list-of-projects.properties
```

Trigger report generation by comment in Pull Request:
```
Github, generate report
```
or as alternative by comment
```
Github, generate report for configs in PR description
```
33 changes: 33 additions & 0 deletions JavadocParagraph/Example3/config.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name = "Checker">
<property name="charset" value="UTF-8"/>

<!-- do not change severity to 'error', as that will hide errors caused by exceptions -->
<property name="severity" value="warning"/>

<!-- haltOnException is required for exception fixes and reporting of all exceptions -->
<property name="haltOnException" value="false"/>

<!-- BeforeExecutionFileFilters is required for sources of java9 -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$" />
</module>

<module name="TreeWalker">
<!-- as we run on regression even on non-compiled files we need to skip exceptions on them -->
<property name="skipFileOnJavaParseException" value="true"/>
<property name="javaParseExceptionSeverity" value="ignore"/>

<module name="JavadocParagraph"/>

<!-- suppress javadoc parsing errors, as we test Check not a parser -->
<module name="SuppressionXpathSingleFilter">
<property name="message" value="Javadoc comment at column \d+ has parse error"/>
</module>
</module>

</module>
43 changes: 43 additions & 0 deletions JavadocParagraph/Example3/list-of-projects.properties

Large diffs are not rendered by default.

367 changes: 367 additions & 0 deletions JavadocParagraph/Example3/list-of-projects.yml

Large diffs are not rendered by default.

29 changes: 29 additions & 0 deletions JavadocParagraph/Example4/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Example4 Configs

Bellow are two options that will do the same but use different versions
of github actions in checkstyle repository.


### Option 1
Trigger report generation by comment in Pull Request:
```
Github, generate report for JavadocParagraph/Example4
```

### Option 2

Paste below given to PR description to use such test configs:
```
Report label: JavadocParagraph/Example4
Diff Regression config: https://raw.githubusercontent.com/checkstyle/test-configs/main/JavadocParagraph/Example4/config.xml
Diff Regression projects: https://raw.githubusercontent.com/checkstyle/test-configs/main/JavadocParagraph/Example4/list-of-projects.properties
```

Trigger report generation by comment in Pull Request:
```
Github, generate report
```
or as alternative by comment
```
Github, generate report for configs in PR description
```
35 changes: 35 additions & 0 deletions JavadocParagraph/Example4/config.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name = "Checker">
<property name="charset" value="UTF-8"/>

<!-- do not change severity to 'error', as that will hide errors caused by exceptions -->
<property name="severity" value="warning"/>

<!-- haltOnException is required for exception fixes and reporting of all exceptions -->
<property name="haltOnException" value="false"/>

<!-- BeforeExecutionFileFilters is required for sources of java9 -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$" />
</module>

<module name="TreeWalker">
<!-- as we run on regression even on non-compiled files we need to skip exceptions on them -->
<property name="skipFileOnJavaParseException" value="true"/>
<property name="javaParseExceptionSeverity" value="ignore"/>

<module name="JavadocParagraph">
<property name="allowNewlineParagraph" value="false"/>
</module>

<!-- suppress javadoc parsing errors, as we test Check not a parser -->
<module name="SuppressionXpathSingleFilter">
<property name="message" value="Javadoc comment at column \d+ has parse error"/>
</module>
</module>

</module>
Loading

0 comments on commit aa4ff48

Please sign in to comment.