pipelinecomponents/pylint

Pipeline Components: Pylint

镜像概述和主要用途

该镜像是一个包含Pylint的Docker容器，专为GitLab CI环境设计。Pylint安装在/app/目录下，便于使用前进行自定义配置。同时内置pylint-gitlab插件，可轻松实现GitLab报告功能，适用于CI/CD流水线中的Python代码静态分析。

核心功能和特性

• 容器化Pylint工具，可直接集成到GitLab CI/CD流水线
• 内置pylint-gitlab插件，支持生成GitLab兼容的代码质量报告
• Pylint安装路径为/app/，支持使用前的自定义安装配置
• 支持GitLab Code Climate报告格式，可作为CI artifacts上传

使用场景和适用范围

适用于GitLab CI/CD流水线中的Python项目代码静态分析（linting），特别适合需要自动化代码质量检查并生成GitLab兼容报告的场景。可用于各类Python项目的CI流程，确保代码符合PEP 8等规范。

使用方法和配置说明

基础使用示例

在GitLab CI配置文件（.gitlab-ci.yml）中添加以下配置：

yaml
pylint:
  stage: linting
  image: registry.gitlab.com/pipeline-components/pylint:latest
  script:
    - pylint **/*.py

带pylint-gitlab的使用示例

如需生成GitLab Code Quality报告，配置如下：

yaml
pylint:
  stage: linting
  image: registry.gitlab.com/pipeline-components/pylint:latest
  script:
    - pylint --exit-zero --load-plugins=pylint_gitlab --output-format=gitlab-codeclimate:codeclimate.json **/*.py
  artifacts:
    reports:
      codequality: codeclimate.json
    when: always

版本控制

本项目采用语义化版本控制进行版本编号。

支持

有疑问？您可以通过以下方式获取帮助：

• 查看***频道
• 提交Issue

贡献

这是一个活跃的开源项目。我们欢迎任何使用代码或为项目做贡献的人。

有关贡献指南，请参阅单独的贡献指南文档。

感谢您的参与！:heart_eyes:

作者与贡献者

本仓库的初始设置由Robbert Müller完成。

构建流水线很大程度上基于https://github.com/hassio-addons，由https://github.com/frenck开发。

完整的作者和贡献者列表，请查看贡献者页面。

许可证

MIT许可证

版权所有 (c) 2020 Robbert Müller

特此授予任何获得本软件及相关文档文件（以下简称“软件”）副本的人免费许可，允许其不受限制地处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向其提供软件的人这样做，但须符合以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的担保，包括但不限于对适销性、特定用途适用性和非侵权性的担保。在任何情况下，作者或版权持有人均不对因软件或软件使用或其他交易引起的任何索赔、损害或其他责任承担责任，无论是合同诉讼、侵权行为还是其他方式。