Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
morphy2k committed Dec 7, 2020
1 parent cf8912d commit e9ff3d4
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
# Revive Action

This Action runs [Revive](https://github.com/mgechev/revive) on your [Go](https://golang.org/) code and adds optional annotations to the check.

## Usage

Checkout

```YAML
- name: Check out code into the Go module directory
uses: actions/checkout@v1
```
Use by building from repository
```YAML
- name: Run Revive Action by building from repository
uses: morphy2k/revive-action@v1
```
Use by pulling pre-built image *(faster execution time, less secure)*
Use by pulling pre-built image
```YAML
- name: Run Revive Action by pulling pre-built image
uses: docker://morphy/revive-action:v1
```
Configuration
```YAML
with:
# Path to your Revive config within the repo (optional)
Expand All @@ -27,6 +35,8 @@ Configuration
exclude: "file.go;foo/bar.go;./foo/bar/..."
# Path pattern (default: ./...)
path: "./foo/..."
# Name of the ckeck (default: revive-action)
name: "Revive"
env:
# GitHub token for annotations (optional)
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -36,4 +46,4 @@ Configuration
![Screenshot of annotations](screenshot.png)
*GitHub Annotations*
_GitHub Annotations_

0 comments on commit e9ff3d4

Please sign in to comment.