peterdavehello/yamllint

docker-yamllint

![Build Status]([] ![Docker image layers]([]

Docker化的https://github.com/adrienverge/yamllint%EF%BC%8C%E6%94%AF%E6%8C%81%E5%A4%9A%E4%B8%AA%E7%89%88%E6%9C%AC%EF%BC%8C%E6%98%93%E4%BA%8E%E4%BD%BF%E7%94%A8%E4%B8%94%E4%BE%BF%E4%BA%8E%E4%B8%8ECI%E9%9B%86%E6%88%90%E3%80%82

目录

• 用法
  • 命令行
    • 使用最新版本
    • 使用特定版本
  • 持续集成（CI）
    • Travis CI
    • GitLab CI
• 构建

用法

命令行

使用最新版本

sh
docker run --rm -v $PATH_TO_YAML:/yaml peterdavehello/yamllint yamllint YAML_FILE.yml

# 请将"$PATH_TO_YAML"替换为您的自定义路径，
# 并将"YAML_FILE.yml"替换为您实际的YAML文件名。

使用特定版本

与上述类似，但您可以指定yamllint的版本，例如：

sh
docker run --rm -v $PATH_TO_YAML:/yaml peterdavehello/yamllint:1.16.0 yamllint YAML_FILE.yml

# 请将"1.16.0"替换为您想要的版本号。
# 不要忘记替换"$PATH_TO_YAML"和"YAML_FILE.yml"。

持续集成（CI）

Travis CI

在您的.travis.yml中启用Docker服务：

yaml
services:
  - docker

并在scripts部分使用与命令行中提到的相同命令，例如：

yaml
services:
  - docker

scripts:
  - docker run --rm -v $TRAVIS_BUILD_DIR:/yaml peterdavehello/yamllint:1.16.0 yamllint .travis.yml

这将校验Travis CI配置文件.travis.yml

GitLab CI

在您的.gitlab-ci.yml中添加以下块：

yaml
yamllint:
  stage: lint
  variables:
    yamllint_version: "1.16.0"
  image: peterdavehello/yamllint:$yamllint_version
  only:
    changes:
      - "**/*.yml"
      - "**/*.yaml"
  script:
    - find . -name "*.yml" -o -name "*.yaml" | xargs -n 1 yamllint

将"1.16.0"替换为您想要使用的版本，您也可以使用"latest"获取最新版本。

构建

构建命令，您需要为YAMLLINT_VERSION指定有效的yamllint版本参数：

sh
docker build --build-arg YAMLLINT_VERSION="1.16.0" -t docker-yamllint .

# 将"docker-yamllint"替换为您偏好的镜像名称

您可以在PyPI的发布历史中找到有效的版本，或者通过API获取更多详情。