Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
adangel committed Feb 10, 2022
1 parent c27bf2f commit eba3aac
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ The input `rulesets` is mandatory.
steps:
- uses: actions/setup-java@v2
with:
distribution: 'temurin'
java-version: '11'
distribution: 'temurin'
- uses: pmd/pmd-github-action@v1
with:
rulesets: 'ruleset.xml'
Expand All @@ -35,8 +35,8 @@ Use a specific PMD version (6.40.0) and fail the build based on the number of vi
steps:
- uses: actions/setup-java@v2
with:
distribution: 'temurin'
java-version: '11'
distribution: 'temurin'
- uses: pmd/pmd-github-action@v1
id: pmd
with:
Expand All @@ -54,10 +54,9 @@ Create Code scanning alerts by uploading a SARIF file to GitHub:
steps:
- uses: actions/setup-java@v2
with:
distribution: 'temurin'
java-version: '11'
distribution: 'temurin'
- uses: pmd/pmd-github-action@v1
id: pmd
with:
rulesets: 'ruleset.xml'
analyzeModifiedFilesOnly: false
Expand All @@ -78,7 +77,7 @@ See also [Uploading a SARIF file to GitHub](https://docs.github.com/en/code-secu
|`version` |no |"latest"|PMD version to use. Using "latest" automatically downloads the latest version.<br>Available versions: https://github.com/pmd/pmd/releases|
|`sourcePath`|no |"." |Root directory for sources. Uses by default the current directory|
|`rulesets` |yes| |Comma separated list of ruleset names to use.|
|`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.|
|`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.|
|`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.|

## Outputs
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ inputs:
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
complete picture of the project. Otherwise alerts might get closed too
soon.
required: false
default: 'true'
Expand Down

0 comments on commit eba3aac

Please sign in to comment.