README

该插件是Panaly项目分析器的一部分，可以用于启用支持路径接收的指标，这些指标来自CODEOWNERS文件。

示例配置

# panaly.dist.yaml
plugins:
    DZunke\PanalyCodeOwners\CodeOwnersPlugin:
        codeowners: CODEOWNERS
        exclude_directories: [ 'vendor' ]
        replace:
            -   metric: filesystem.file_count
                type: relative
                write: paths
                option: paths
                owners: [ '@Hulk', '@DrStrange' ]

groups:
    ownership:
        title: "Information around the Project Ownership"
        metrics:
            unowned_directories: ~
            owned_files_count:
                owners: [ '@my_owner_group' ]
            owned_files_list:
                owners: [ '@my_owner_group' ]
            owned_directories_count:
                owners: [ '@my_owner_group', '@another_owner_group' ]
            owned_directories_list:
                owners: [ '@my_owner_group', '@another_owner_group' ]

单个指标的替换选项

可用指标

无主目录

名为unowned_directories的目录计数提供Table结果，列出所有无主目录。注意，列表可能非常长。没有可用的选项。使用插件选项中的CODEOWNER文件。

所有者文件计数

名为owned_files_count的文件计数提供IntegerValue结果，总结了特定所有者的所有所有者文件。必须提供所有者选项以使指标正确工作，否则将返回零值。

所有者文件列表

名为owned_files_list的文件计数提供Table结果，列出所有具有特定所有者相对路径的所有者文件。必须提供所有者选项以使指标正确工作，否则将返回空列表。

所有者目录计数

名为owned_directories_count的目录计数提供IntegerValue结果，总结了特定所有者的所有所有者目录。必须提供所有者选项以使指标正确工作，否则将返回零值。

所有者目录列表

名为owned_directories_list的文件计数提供Table结果，列出所有具有特定所有者相对路径的所有者目录。必须提供所有者选项以使指标正确工作，否则将返回空列表。

已知问题

• CODEOWNERS文件没有通用规范，因此目前只支持GitHub规范
  • 例如，Gitlab规范（带有部分和部分所有者）不受支持

感谢和许可

Panaly项目分析器 - CODEOWNERS插件 © 2024+, Denis Zunke。使用MIT许可发布。

GitHub @dzunke  ·  Twitter @DZunke