korvoj/helm-lint-yq

helm-lint-yq

镜像概述

helm-lint-yq是一个基于https://github.com/helm/chart-testing%E6%9E%84%E5%BB%BA%E7%9A%84Docker%E9%95%9C%E5%83%8F%EF%BC%8C%E9%A2%9D%E5%A4%96%E9%9B%86%E6%88%90%E4%BA%86%E4%B8%A4%E4%B8%AA%E5%AE%9E%E7%94%A8%E5%B7%A5%E5%85%B7%EF%BC%9Ahttps://github.com/fsaintjacques/semver-tool%EF%BC%88Bash%E8%AF%AD%E4%B9%89%E5%8C%96%E7%89%88%E6%9C%AC%E7%AE%A1%E7%90%86%E5%B7%A5%E5%85%B7%EF%BC%89%E5%92%8Chttps://github.com/mikefarah/yq%EF%BC%88%E5%A4%9A%E6%A0%BC%E5%BC%8F%E6%95%B0%E6%8D%AE%E5%A4%84%E7%90%86%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7%EF%BC%89%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%8F%90%E4%BE%9B%E4%B8%80%E4%BD%93%E5%8C%96%E8%A7%A3%E5%86%B3%E6%96%B9%E6%A1%88%EF%BC%8C%E6%94%AF%E6%8C%81Helm%E5%9B%BE%E8%A1%A8%E7%9A%84%E6%B5%8B%E8%AF%95%E9%AA%8C%E8%AF%81%E4%BB%A5%E5%8F%8A%E5%B0%B1%E5%9C%B0%E6%9B%B4%E6%96%B0%E5%9B%BE%E8%A1%A8%E4%B8%AD%E7%9A%84%60.appVersion%60%E5%92%8C%60.version%60%E5%AD%97%E6%AE%B5%E3%80%82

源代码托管于https://github.com/korvoj/dockerfiles/tree/master/helm-lint-yq%E3%80%82

核心功能和特性

• 基础图表测试能力：继承helm/chart-testing的核心功能，支持Helm图表的 lint 检查、依赖验证等测试流程
• 语义化版本管理：集成semver-tool，提供语义化版本解析、比较、递增等操作（如版本号比较、生成下一个版本等）
• 多格式数据处理：集成yq工具，支持YAML、JSON、XML、CSV、TOML及properties文件的命令行处理
• 版本字段更新：支持直接在Helm图表文件中就地更新.appVersion（应用版本）和.version（图表版本）字段

使用场景和适用范围

• CI/CD流程集成：在持续集成/部署管道中自动化执行Helm图表的质量检查和版本管理
• Helm图表开发：图表开发过程中快速验证格式正确性并管理版本号
• 批量配置更新：需要统一修改多个Helm图表版本信息的场景
• 语义化版本控制：对图表版本有严格语义化版本要求的项目

使用方法和配置说明

基本使用方式

通过docker run命令运行容器，挂载本地Helm图表目录进行操作：

bash
docker run --rm -v /path/to/your/helm/charts:/charts korvoj/helm-lint-yq [command]

常用命令示例

1. 执行Helm图表测试（继承自chart-testing）

bash
# 检查指定目录下的Helm图表
docker run --rm -v /path/to/charts:/charts korvoj/helm-lint-yq ct lint --charts /charts/my-chart

2. 使用yq更新图表版本字段

bash
# 更新图表的version字段为1.2.3
docker run --rm -v /path/to/charts:/charts korvoj/helm-lint-yq yq eval ".version = \"1.2.3\"" -i /charts/my-chart/Chart.yaml

# 同时更新version和appVersion字段
docker run --rm -v /path/to/charts:/charts korvoj/helm-lint-yq yq eval ".version = \"1.2.3\" | .appVersion = \"2.3.4\"" -i /charts/my-chart/Chart.yaml

3. 使用semver-tool进行版本管理

bash
# 比较两个版本号
docker run --rm korvoj/helm-lint-yq semver compare 1.2.3 1.2.4

# 生成下一个补丁版本（1.2.3 -> 1.2.4）
docker run --rm korvoj/helm-lint-yq semver bump patch 1.2.3

# 生成下一个主版本（1.2.3 -> 2.0.0）
docker run --rm korvoj/helm-lint-yq semver bump major 1.2.3

集成到CI/CD示例（GitLab CI）

在.gitlab-ci.yml中配置自动化测试和版本更新：

yaml
helm-test:
  image: korvoj/helm-lint-yq
  script:
    - ct lint --charts ./charts/my-chart
    - yq eval ".version = \"$(semver bump patch $(yq eval '.version' ./charts/my-chart/Chart.yaml))\"" -i ./charts/my-chart/Chart.yaml
  only:
    - merge_requests

工具详细文档

• https://github.com/helm/chart-testing/blob/master/docs/ct_lint.md
• https://github.com/fsaintjacques/semver-tool#usage
• https://mikefarah.gitbook.io/yq/