seiso/goat

Grand Opinionated AutoTester (GOAT)

Grand Opinionated AutoTester (GOAT) 可自动应用Seiso的策略即代码。该项目设计目标是比其他开源多检查器项目更易于理解、更具意见性，并且易于扩展以通过编程方式执行Seiso策略。

快速开始

1. 创建每个仓库的字典（相对于Git仓库根目录）。

   bash
   mkdir -p .github/etc/
   touch .github/etc/dictionary.txt
   

2. 确保在GitHub Action中检出代码。

   bash
   uses: actions/checkout@v4
   

3. 将GOAT添加到GitHub Actions工作流中。

   bash
   uses: seisollc/goat@main
   

示例

要在每个针对main分支的PR上运行GOAT，创建文件.github/workflows/pr.yml，内容如下：

yml
---
on:
  pull_request:
    branches:
      - main
jobs:
  test:
    runs-on: Ubuntu-20.04
    name: 测试项目
    steps:
    - uses: actions/checkout@v4
    - uses: seisollc/goat@main

自定义配置

1. 在.github/etc/dictionary.txt中填充自定义字典文件，用于存储仓库特定的语言。

   bash
   $ cat << EOF >> .github/etc/dictionary.txt
   capricornis
   crispus
   EOF
   

2. 配置GOAT跳过mypy扫描。

   bash
   uses: seisollc/goat@main
   with:
     disable_mypy: true
   

3. 排除文件扩展名。

   bash
   uses: seisollc/goat@main
   with:
     exclude: \.md$
   

4. 排除文件列表。

   bash
   uses: seisollc/goat@main
   with:
     exclude: ^.*/(Dockerfile|Dockerfile\.dev)$
   

5. 在仓库的.github/linters/目录中为任何受支持的检查器提供检查配置。

   bash
   $ mkdir -p .github/linters/
   $ cat << EOF >> .github/linters/.markdown-lint.yml
   ---
   MD013:
     line_length: 120
   EOF
   

6. 使用内置的fix选项通过检查器自动修复代码格式错误。注意：本地运行时默认启用此选项，可能会使Git目录处于"脏"状态，需要手动管理提交和推送更改。

   bash
   uses: seisollc/goat@main
   with:
     auto_fix: false
   

支持的检查器

• actionlint
• black
• cfn-lint
• cspell
• dockerfile_lint
• hadolint
• jscpd
• kubeconform
• markdown-link-check
• markdownlint
• mypy
• ruff
• shellcheck
• textlint
• yamllint

支持的流水线

• GitHub Actions
• Bitbucket Pipelines

调试

要调试GOAT相关问题，可将日志级别配置为ERROR、WARN、INFO或DEBUG。

bash
uses: seisollc/goat@main
with:
  log_level: DEBUG

版本发布

goat项目不进行版本发布，其设计初衷是作为不断演进的最低期望标准。请直接使用main分支，或在有限情况下固定到每个提交发布的提交哈希标签。

GOAT开发

详见CONTRIBUTING.md