flake8 Docker镜像文档

镜像概述

主要用途

本镜像为flake8（Python代码静态分析工具）提供容器化运行环境，支持在新发布版本时自动触发构建，确保镜像与***版本同步。适用于快速部署flake8进行Python代码质量检查，无需本地安装依赖。

核心功能与特性

• 多架构支持：兼容多种硬件架构，包括linux/arm/v7、linux/arm64/v8、linux/arm/v6、linux/amd64、linux/ppc64le、linux/s390x
• 自动构建：通过CI定时任务监控flake8新版本发布，自动触发镜像构建流程
• 轻量级：基于Alpine Linux构建，镜像体积小，资源占用低
• 版本标签化：提供特定版本标签（如3.5.0），确保使用稳定性

使用场景

• 本地开发：开发环境中快速检查Python代码的语法错误、PEP8规范符合性及代码复杂度
• CI/CD集成：作为自动化流程的一部分，在代码提交或合并前执行静态分析
• 多架构环境：在ARM、x86等不同架构设备上提供一致的代码检查体验

使用方法

基本运行命令

需将本地目录挂载至容器内/apps目录（必须操作），以便容器访问待检查文件：

bash
# 检查指定Python文件
docker run -ti --rm -v $(pwd):/apps alpine/flake8:3.5.0 local_file.py

# 查看flake8帮助信息
docker run -ti --rm -v $(pwd):/apps alpine/flake8:3.5.0 --help

作为命令别名使用

通过设置别名，可将容器作为本地命令直接调用：

bash
# 创建别名（以3.5.0版本为例）
alias flake="docker run -ti --rm -v $(pwd):/apps alpine/flake8:3.5.0"

# 使用别名检查当前目录所有Python文件
flake *.py

# 使用别名指定检查规则（如忽略E501错误）
flake --ignore=E501 src/

配置参数说明

容器工作目录固定为/apps，支持flake8所有标准命令行参数：

• 文件/目录路径：指定待检查的Python文件或目录（如local_file.py、src/）
• --max-line-length=N：设置最大行长度（默认79）
• --ignore=ERROR_CODE：忽略指定错误码（如E501）
• --select=ERROR_CODE：仅检查指定错误码
• --show-source：显示错误对应的代码行

镜像构建流程

1. 定时触发：CI定时任务（每周）在主分支自动执行构建
2. 版本同步：构建并推送latest标签镜像，确保与flake8最新版本同步
3. 版本标记：本地运行最新镜像获取应用版本，为镜像添加版本标签（如3.5.0）
4. 镜像推送：使用crane工具推送版本标签镜像至Docker Hub

相关链接

• Dockerfile仓库：[***]
• 构建日志：[***]
• 镜像标签页：[***]