You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,8 @@ The input `rulesets` is mandatory.
20
20
steps:
21
21
- uses: actions/setup-java@v2
22
22
with:
23
-
distribution: 'temurin'
24
23
java-version: '11'
24
+
distribution: 'temurin'
25
25
- uses: pmd/pmd-github-action@v1
26
26
with:
27
27
rulesets: 'ruleset.xml'
@@ -35,8 +35,8 @@ Use a specific PMD version (6.40.0) and fail the build based on the number of vi
35
35
steps:
36
36
- uses: actions/setup-java@v2
37
37
with:
38
-
distribution: 'temurin'
39
38
java-version: '11'
39
+
distribution: 'temurin'
40
40
- uses: pmd/pmd-github-action@v1
41
41
id: pmd
42
42
with:
@@ -54,10 +54,9 @@ Create Code scanning alerts by uploading a SARIF file to GitHub:
54
54
steps:
55
55
- uses: actions/setup-java@v2
56
56
with:
57
-
distribution: 'temurin'
58
57
java-version: '11'
58
+
distribution: 'temurin'
59
59
- uses: pmd/pmd-github-action@v1
60
-
id: pmd
61
60
with:
62
61
rulesets: 'ruleset.xml'
63
62
analyzeModifiedFilesOnly: false
@@ -78,7 +77,7 @@ See also [Uploading a SARIF file to GitHub](https://docs.github.com/en/code-secu
78
77
|`version` |no |"latest"|PMD version to use. Using "latest" automatically downloads the latest version.<br>Available versions: https://github.com/pmd/pmd/releases|
79
78
|`sourcePath`|no |"." |Root directory for sources. Uses by default the current directory|
80
79
|`rulesets` |yes| |Comma separated list of ruleset names to use.|
81
-
|`analyzeModifiedFilesOnly`|no|"true"|Instead of analyze all files under "sourcePath", only the files that have been touched in a pull request or push will be analyzed. This makes the analysis faster and helps especially bigger projects which gradually want to introduce PMD. This helps in enforcing that no new code violation is introduced.<br>Depending on the analyzed language, the results might be less accurate results. At the moment, this is not a problem, as PMD mostly analyzes each file individually, but that might change in the future.<br>If the change is very big, not all files might be analyzed. Currently the maximum number of modified files is 300.<br>Note: When using PMD as a code scanner in order to create "Code scanning alerts" on GitHub, all files should be analyzed in order to produce a complete picture of the project. Otherwise alerts might get closed soo soon.|
80
+
|`analyzeModifiedFilesOnly`|no|"true"|Instead of analyze all files under "sourcePath", only the files that have been touched in a pull request or push will be analyzed. This makes the analysis faster and helps especially bigger projects which gradually want to introduce PMD. This helps in enforcing that no new code violation is introduced.<br>Depending on the analyzed language, the results might be less accurate results. At the moment, this is not a problem, as PMD mostly analyzes each file individually, but that might change in the future.<br>If the change is very big, not all files might be analyzed. Currently the maximum number of modified files is 300.<br>Note: When using PMD as a code scanner in order to create "Code scanning alerts" on GitHub, all files should be analyzed in order to produce a complete picture of the project. Otherwise alerts might get closed too soon.|
82
81
|`createGitHubAnnotations`|no|"true"|By default, all detected violations are added as annotations to the pull request. You can disable this by setting FALSE. This can be useful if you are using another tool for this purpose.|
0 commit comments