Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/morphy2k/revive-action
Lint your Go code with Revive
https://github.com/morphy2k/revive-action
action annotations code go lint quality revive utility
Last synced: 5 days ago
JSON representation
Lint your Go code with Revive
- Host: GitHub
- URL: https://github.com/morphy2k/revive-action
- Owner: morphy2k
- License: mit
- Created: 2019-08-30T23:16:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-11T15:12:23.000Z (25 days ago)
- Last Synced: 2024-10-15T16:21:40.956Z (21 days ago)
- Topics: action, annotations, code, go, lint, quality, revive, utility
- Language: Go
- Homepage:
- Size: 198 KB
- Stars: 38
- Watchers: 2
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Revive Action
This Action runs [Revive](https://github.com/mgechev/revive) on your [Go](https://golang.org/) code and adds annotations to the check.
## Usage
### Checkout
```YAML
- name: Check out code into the Go module directory
uses: actions/checkout@v4
```
### Use by pulling pre-built image **(recommended)**
#### Docker Hub image
```YAML
- name: Run Revive Action by pulling pre-built image
uses: docker://morphy/revive-action:v2
```
#### GitHub Container registry image
```YAML
- name: Run Revive Action by pulling pre-built image
uses: docker://ghcr.io/morphy2k/revive-action:v2
```
### Use by building from repository
```YAML
- name: Run Revive Action by building from repository
uses: morphy2k/revive-action@v2
```
### Configuration
```YAML
with:
# Path to your Revive config within the repo (optional)
config: revive/config.toml
# Exclude patterns, separated by semicolons (optional)
exclude: "file.go;foo/bar.go;./foo/bar/..."
# Path pattern (default: ./...)
path: "./foo/..."
```
### Workflow example
```YAML
name: Lint
on:
pull_request:
push:
paths:
- '**.go'
- 'go.mod'
- 'go.sum'
- 'revive.toml'
jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Check out code into the Go module directory
uses: actions/checkout@v4
- name: Run Revive Action
uses: docker://morphy/revive-action:v2
with:
config: revive.toml
```
## Screenshots
_GitHub Annotations_