morphy/revive-action

Revive Action

概述和主要用途

Revive Action是一个GitHub Action，用于在Go代码上运行Revive静态分析工具，并在检查过程中添加注释。Revive是Go语言的快速、可配置代码审查工具，可帮助开发者发现代码潜在问题和不规范写法，提升代码质量。

核心功能和特性

• 支持两种使用方式：拉取预构建镜像（资源效率更高，执行时间更短）或从仓库构建
• 可通过配置文件自定义Revive检查规则
• 支持排除特定文件/目录，避免不必要检查
• 可指定检查路径模式，灵活控制检查范围
• 提供失败控制选项，可配置是否在发现任何问题时使工作流失败

使用场景和适用范围

适用于GitHub上的Go项目，可集成到CI/CD工作流中，在拉取请求或推送Go相关文件时自动执行代码质量检查，确保代码符合项目规范。

使用方法和配置说明

检出代码

使用前需先检出代码到Go模块目录：

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

使用预构建镜像

Docker Hub镜像

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

GitHub Container Registry镜像

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

[!NOTE] 使用预构建镜像资源效率更高，执行时间更短。

从仓库构建使用

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

配置参数说明

通过with关键字配置以下参数：

参数详情：

• config: 指定自定义Revive配置文件路径（如revive.toml），用于定义检查规则
• exclude: 排除模式支持...通配符（如./foo/bar/...表示排除该目录下所有内容）
• path: 默认检查当前目录所有内容（./...），可限定范围（如./foo/...）
• fail-on-any: 设为true时，任何检查问题都会导致Action失败

工作流示例

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
          exclude: |
            file.go
            foo/bar.go
            ./foo/bar/...
          path: ./foo/...
          fail-on-any: true