Skip to content

Commit

Permalink
xcop github action usage
Browse files Browse the repository at this point in the history
  • Loading branch information
g4s8 committed Apr 30, 2020
1 parent 6bad77f commit bb162a9
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Expand Up @@ -72,6 +72,36 @@ Xcop::RakeTask.new(:xcop) do |task|
end
```

## How to use as GitHub action?

Create new workflow file in repository under `.github/workflows/xcop.yml`:
```yaml
---
name: XCOP
"on":
# run on push to master events
push:
branches:
- master
# run on pull requests to master
pull_request:
brranches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: g4s8/xcop-action@master
```
To customize license location or files pattern use action inputs `license` and `files`:
```yaml
- uses: g4s8/xcop-action@master
with:
license: MY_LICENSE.txt
files: "src/*.xml"
```

## How to use in Maven `pom.xml`?

You can integrate it with the help of
Expand Down

0 comments on commit bb162a9

Please sign in to comment.