Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
morphy2k committed Nov 10, 2024
1 parent cd0ca64 commit df3f264
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,10 @@ This Action runs [Revive](https://github.com/mgechev/revive) on your [Go](https:
uses: docker://ghcr.io/morphy2k/revive-action:v2
```
### Use by building from repository
> [!NOTE]
> **Using a pre-built image is recommended.**
>
> It is more resource-efficient and has a shorter execution time.
> Using a pre-built image is more resource-efficient and has a shorter execution time.
### Use by building from repository
```YAML
- name: Run Revive Action by building from repository
Expand All @@ -44,16 +42,16 @@ This Action runs [Revive](https://github.com/mgechev/revive) on your [Go](https:
```YAML
with:
# Path to your Revive config within the repo (optional)
config: revive/config.toml
config: revive.toml

# Exclude patterns (optional)
# Exclude patterns (default: vendor/...)
exclude: |
file.go
foo/bar.go
./foo/bar/...
# Path pattern (default: ./...)
path: "./foo/..."
path: ./foo/...

# Fail on any issue. Overrides the error and warning code in config (default: false)
fail-on-any: true
Expand Down

0 comments on commit df3f264

Please sign in to comment.