README.md

Revive Action

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

Usage

Checkout

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

Use by pulling pre-built image

Docker Hub image

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

GitHub Container registry image

- name: Run Revive Action by pulling pre-built image
  uses: docker://ghcr.io/morphy2k/revive-action:v2

Note

Using a pre-built image is more resource-efficient and has a shorter execution time.

Use by building from repository

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

Configuration

  with:
    # Path to your Revive config within the repo (optional)
    config: revive.toml

    # Exclude patterns (default: vendor/...)
    exclude: |
      file.go
      foo/bar.go
      ./foo/bar/...

    # Path pattern (default: ./...)
    path: ./foo/...

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

Workflow example

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