revive-action

command module
v1.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 16, 2021 License: MIT Imports: 10 Imported by: 0

README

Revive Action

This Action runs Revive on your Go code and adds optional annotations to the check.

Usage

Checkout

- name: Check out code into the Go module directory
  uses: actions/checkout@v2

Use by building from repository

- name: Run Revive Action by building from repository
  uses: morphy2k/revive-action@v1

Use by pulling pre-built image

- name: Run Revive Action by pulling pre-built image
  uses: docker://morphy/revive-action:v1

Configuration

  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/..."
    # Name of the check (default: revive-action)
    name: "Revive"
  env:
    # GitHub token for annotations (optional)
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Screenshots

Screenshot of annotations

GitHub Annotations

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL