smoench/deptrac-action

deptrac-action

镜像概述和主要用途

deptrac-action是一个GitHub Action，用于运行https://github.com/qossmic/deptrac%E5%B7%A5%E5%85%B7%E3%80%82%E9%80%9A%E8%BF%87%E6%8C%87%E5%AE%9A%60args%60%E5%8F%82%E6%95%B0%E5%AE%9A%E4%B9%89%E8%BF%90%E8%A1%8C%E5%91%BD%E4%BB%A4%E5%92%8C%E4%BE%9D%E8%B5%96%E6%96%87%E4%BB%B6%EF%BC%88depfile%EF%BC%89%EF%BC%8C%E5%8F%AF%E5%9C%A8%E4%BB%A3%E7%A0%81%E5%B1%82%E9%97%B4%E5%87%BA%E7%8E%B0%E4%BE%9D%E8%B5%96%E8%BF%9D%E8%A7%84%E6%97%B6%E4%BD%BF%E5%B7%A5%E4%BD%9C%E6%B5%81%E5%A4%B1%E8%B4%A5%EF%BC%8C%E4%BB%8E%E8%80%8C%E5%AE%9E%E7%8E%B0%E8%87%AA%E5%8A%A8%E5%8C%96%E7%9A%84%E4%BB%A3%E7%A0%81%E4%BE%9D%E8%B5%96%E8%A7%84%E8%8C%83%E6%A3%80%E6%B5%8B%E3%80%82

核心功能和特性

• 集成deptrac工具：直接运行qossmic/deptrac进行代码依赖分析
• 灵活配置：通过args参数自定义运行命令和依赖文件
• 违规检测：发现代码层间依赖违规时自动使工作流失败
• 两种使用方式：支持预构建Docker镜像（快速）和GitHub仓库构建（自定义）

使用场景和适用范围

适用于需要在GitHub工作流中集成代码依赖规范检测的项目，特别是使用qossmic/deptrac进行架构治理的PHP项目。可在代码推送（push）或拉取请求（pull_request）时自动运行，确保代码依赖符合预设架构规则。

使用方法和配置说明

配置工作流

在.github/workflows/目录下创建或修改CI配置文件（如ci.yml），添加deptrac任务。详细工作流配置可参考https://help.github.com/en/articles/configuring-a-workflow%E3%80%82

方式一：使用预构建Docker镜像（推荐，速度更快）

yaml
on: [push, pull_request]
name: Test
jobs:
  deptrac:
    name: deptrac
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: deptrac
      uses: docker://smoench/deptrac-action:latest
      with:
        args: analyse depfile.yaml

也可直接执行Docker镜像：

shell
docker run --interactive --rm --tty --workdir=/app --volume ${PWD}:/app docker.xuanyuan.run/smoench/deptrac-action:latest analyse depfile.yaml

更多Docker运行参数可参考https://docs.docker.com/engine/reference/run/%E3%80%82

方式二：使用GitHub仓库构建（自定义，速度较慢）

若需GitHub自动构建镜像，可直接指定仓库地址：

yaml
name: CI

on: push

jobs:
  deptrac:
    name: deptrac
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: deptrac
        uses: smoench/deptrac-action@master

许可证

本镜像使用MIT许可证。

credits

本GitHub Action的实现很大程度上受https://github.com/localheinz%E7%9A%84GitHub Action https://github.com/localheinz/composer-normalize-action%E5%90%AF%E5%8F%91%E3%80%82