essentialkaos/perfecto

perfecto 工具文档

概述

perfecto 是一款用于检查完美编写的RPM规格文件（.spec）的工具。目前，它默认用于EK Public Repository的规格文件检查，确保RPM包规格符合最佳实践和行业标准。

核心功能与特性

• 全面的规格检查：提供多种内置检查项，确保RPM规格文件的完整性和合规性（每个检查项的详细说明可参考https://github.com/essentialkaos/perfecto/wiki%EF%BC%89
• 灵活的输出格式：支持summary、tiny、short、github、json、xml等多种输出格式，适应不同使用场景需求
• 可定制化检查规则：允许通过ID禁用特定检查项，支持自定义RPMLint配置文件，可设置错误级别阈值
• RPMLint集成：默认与RPMLint工具集成，提供更全面的规格文件校验能力（可选择禁用）
• 多环境支持：支持源码安装、预编译二进制、Docker容器化部署以及GitHub Actions集成等多种使用方式

使用场景

• RPM包开发者在本地开发环境中验证.spec文件的合规性
• 集成到CI/CD流程（如GitHub Actions工作流），在代码提交或Pull Request时自动执行规格文件检查
• 作为RPM仓库（如EK Public Repository）的规格文件质量门禁工具，确保入库包的规格规范性

安装与使用指南

安装方式

从源码安装

确保已配置Go 1.17+开发环境（Go安装指南），执行以下命令：

bash
go install github.com/essentialkaos/perfecto@latest

从ESSENTIAL KAOS公共仓库安装

bash
sudo yum install -y https://yum.kaos.st/get/$(uname -r).rpm
sudo yum install perfecto

预编译二进制包

可从EK Apps Repository下载Linux和macOS平台的预编译二进制：

bash
bash <(curl -fsSL https://apps.kaos.st/get) perfecto

与GitHub Actions集成

如需在GitHub Actions工作流中使用最新稳定版perfecto，创建或添加以下perfecto.yml配置文件到工作流目录：

yaml
name: Perfecto

on:
  push:
    branches: [master, develop]
  pull_request:
    branches: [master]

jobs:
  Perfecto:
    name: Perfecto
    runs-on: ubuntu-latest

    steps:
      - name: 代码检出
        uses: actions/checkout@v2

      - name: 登录DockerHub
        uses: docker/login-action@v1
        env:
          DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
        if: ${{ env.DOCKERHUB_USERNAME != '' }}
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: 使用Perfecto检查规格文件
        uses: essentialkaos/perfecto-action@v1
        with:
          files: myapp.spec

更多配置选项可参考https://github.com/marketplace/actions/ek-perfecto%E3%80%82

使用Docker容器

安装最新版Docker后，通过以下步骤使用容器化版本：

bash
# 下载Docker执行脚本
curl -fL# -o perfecto-docker https://kaos.sh/perfecto/perfecto-docker
# 添加执行权限
chmod +x perfecto-docker
# 移动到系统PATH目录
sudo mv perfecto-docker /usr/bin/
# 执行检查（替换为实际.spec文件路径）
perfecto-docker PATH_TO_YOUR_SPEC_FILE

命令行使用说明

基本语法

Usage: perfecto {options} file…

主要选项

使用示例

bash
# 基本检查并打印详细报告
perfecto app.spec

# 不使用RPMLint检查规格文件
perfecto --no-lint app.spec

# 生成精简报告
perfecto --format tiny app.spec

# 生成摘要报告
perfecto --format summary app.spec

# 生成JSON格式报告并保存到文件
perfecto --format json app.spec 1> report.json

构建状态

许可证

本项目基于Apache License, Version 2.0许可协议开源。