Skip to content

Commit

Permalink
Merge pull request #176 from lcollins/lc-enhancements-2024
Browse files Browse the repository at this point in the history
Enhancements
  • Loading branch information
lcollins authored May 4, 2024
2 parents c2b6702 + 6b2338e commit 9e22c16
Show file tree
Hide file tree
Showing 8 changed files with 1,572 additions and 5,278 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Optional. Title for the check run to create. Defaults to `SpotBugs Source Code A
### `token`
Optional. GitHub API access token. Defaults to `${{ github.token }}`, which is set by `actions/checkout@v2` minimally.

### `fail-on-violation`
Optional. Whether to fail the check if any violations are found. Defaults to `false`.

## Example usage

```yaml
Expand All @@ -52,7 +55,7 @@ jobs:
${{ runner.os }}-maven-
- name: Build with Maven
run: mvn -B verify spotbugs:spotbugs
- uses: lcollins/spotbugs-github-action@v2.0.0
- uses: lcollins/spotbugs-github-action@v3.0.0
with:
path: '**/spotbugsXml.xml'
```
Expand Down
4 changes: 4 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ inputs:
Also when generating a new PAT, select the least scopes necessary.
[Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
default: ${{ github.token }}
fail-on-violation:
description: 'Enables status markers to be added to check'
default: false
required: false
runs:
using: 'node20'
main: 'dist/index.js'
Expand Down
Loading

0 comments on commit 9e22c16

Please sign in to comment.