41772ki/danger-swiftlint

镜像概述和主要用途

本Docker镜像集成了https://github.com/danger/swift%E5%92%8Chttps://github.com/realm/SwiftLint%E5%B7%A5%E5%85%B7%E3%80%82Danger-Swift%E7%94%A8%E4%BA%8E%E8%87%AA%E5%8A%A8%E5%8C%96%E4%BB%A3%E7%A0%81%E5%AE%A1%E6%9F%A5%E6%B5%81%E7%A8%8B%EF%BC%8C%E5%8F%AF%E5%9C%A8%E4%BB%A3%E7%A0%81%E6%8F%90%E4%BA%A4%E6%88%96PR%E6%97%B6%E8%87%AA%E5%8A%A8%E7%94%9F%E6%88%90%E5%AE%A1%E6%9F%A5%E5%8F%8D%E9%A6%88%EF%BC%9BSwiftLint%E7%94%A8%E4%BA%8E%E6%A3%80%E6%9F%A5Swift%E4%BB%A3%E7%A0%81%E9%A3%8E%E6%A0%BC%E8%A7%84%E8%8C%83%E6%80%A7%E3%80%82%E9%95%9C%E5%83%8F%E6%94%AF%E6%8C%81%E6%9C%AC%E5%9C%B0%E7%8E%AF%E5%A2%83%E8%BF%90%E8%A1%8C%E5%8F%8ACI/CD%E6%B5%81%E7%A8%8B%EF%BC%88%E5%A6%82GitHub Actions）集成，简化Swift项目的代码质量保障流程。

核心功能和特性

• 一站式集成Danger-Swift与SwiftLint，无需单独配置两者环境
• 支持本地Docker环境快速运行，便于开发阶段测试
• 提供GitHub Actions集成能力，可无缝接入GitHub PR流程
• 不同版本标签对应不同Swift版本，满足项目兼容性需求

使用场景和适用范围

适用于Swift语言项目，尤其适合需要在代码审查阶段自动化执行以下任务的场景：

• 自动检查Swift代码是否符合团队风格规范（通过SwiftLint）
• 在GitHub PR中自动生成代码审查报告（通过Danger-Swift）
• 减少人工审查负担，确保代码风格一致性

详细使用方法和配置说明

本地Docker运行

通过以下命令在本地环境运行镜像，需挂载当前项目目录并指定工作目录：

sh
docker run -v `pwd`:`pwd` -w `pwd` 41772ki/danger-swiftlint local

参数说明：

• -v \pwd`:`pwd``：将当前目录挂载到容器内相同路径，确保工具可访问项目文件
• -w \pwd``：设置容器工作目录为当前目录
• local：Danger-Swift的运行命令，执行本地代码审查

GitHub Actions集成

在GitHub项目中配置Actions工作流，实现PR触发时自动运行代码审查：

yml
name: Danger
on:
  pull_request:
    paths:
      - '.swiftlint.yml'  # SwiftLint配置文件变更时触发
      - '**/*.swift'      # Swift源代码变更时触发
jobs:
  Danger:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2  # 检出项目代码
      - name: Danger
        uses: 417-72KI/danger-swiftlint@v5  # 使用镜像的GitHub Action
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # 必需，用于GitHub API认证

版本说明

镜像版本与Swift版本对应关系如下，选择时需匹配项目使用的Swift版本：

• v5.6+：版本标签与Swift版本一致（如标签v5.6对应Swift 5.6）
• v5：对应Swift 5.5（不再更新）
• v4：对应Swift 5.4（不再更新）
• v3：对应Swift 5.3（不再更新）
• v2：对应Swift 5.2（不再更新）
• v1：对应Swift 5.1（不再更新）

注意：v5及以下版本已停止更新，建议新项目使用v5.6+版本以获取最新Swift支持。