Skip to content

Commit eba3aac

Browse files
committed
Fix typos
1 parent c27bf2f commit eba3aac

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ The input `rulesets` is mandatory.
2020
steps:
2121
- uses: actions/setup-java@v2
2222
with:
23-
distribution: 'temurin'
2423
java-version: '11'
24+
distribution: 'temurin'
2525
- uses: pmd/pmd-github-action@v1
2626
with:
2727
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
3535
steps:
3636
- uses: actions/setup-java@v2
3737
with:
38-
distribution: 'temurin'
3938
java-version: '11'
39+
distribution: 'temurin'
4040
- uses: pmd/pmd-github-action@v1
4141
id: pmd
4242
with:
@@ -54,10 +54,9 @@ Create Code scanning alerts by uploading a SARIF file to GitHub:
5454
steps:
5555
- uses: actions/setup-java@v2
5656
with:
57-
distribution: 'temurin'
5857
java-version: '11'
58+
distribution: 'temurin'
5959
- uses: pmd/pmd-github-action@v1
60-
id: pmd
6160
with:
6261
rulesets: 'ruleset.xml'
6362
analyzeModifiedFilesOnly: false
@@ -78,7 +77,7 @@ See also [Uploading a SARIF file to GitHub](https://docs.github.com/en/code-secu
7877
|`version` |no |"latest"|PMD version to use. Using "latest" automatically downloads the latest version.<br>Available versions: https://github.com/pmd/pmd/releases|
7978
|`sourcePath`|no |"." |Root directory for sources. Uses by default the current directory|
8079
|`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.|
8281
|`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.|
8382

8483
## Outputs

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ inputs:
4646
4747
Note: When using PMD as a code scanner in order to create "Code scanning
4848
alerts" on GitHub, all files should be analyzed in order to produce a
49-
complete picture of the project. Otherwise alerts might get closed soo
49+
complete picture of the project. Otherwise alerts might get closed too
5050
soon.
5151
required: false
5252
default: 'true'

0 commit comments

Comments
 (0)