跳转到主要内容

检查playbooks中的实践和行为,这些实践和行为可能需要改进

项目描述

PyPI version Ansible-lint rules explanation Discussions pre-commit

Ansible-lint

ansible-lint 检查剧本中可能需要改进的实践和行为。作为一个社区支持的项目,ansible-lint 只支持 Ansible 的最后两个主要版本。

访问 Ansible Lint 文档网站

将 ansible-lint 作为 GitHub Action 使用

此操作允许您在您的代码库上运行 ansible-lint,而无需自己安装它。

# .github/workflows/ansible-lint.yml
name: ansible-lint
on:
  pull_request:
    branches: ["main", "stable", "release/v*"]
jobs:
  build:
    name: Ansible Lint # Naming the build is important to use it as a status check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run ansible-lint
        uses: ansible/ansible-lint@main
        # optional (see below):
        with:
          args: ""
          setup_python: "true"
          working_directory: ""
          requirements_file: ""

所有参数都是可选的,大多数用户可能不需要它们

  • args:传递给 ansible-lint 命令的参数。
  • setup_python:是否应该安装 Python。默认值为 true
  • working_directory:从哪里运行 ansible-lint 的目录。默认值为 github.workspace。如果您只想检查仓库的子集,可能需要这个参数。
  • requirements_file:安装角色和集合依赖项的 requirements.yml 文件的路径。

有关更多详细信息,请参阅 ansible-lint-action

沟通

有关如何联系我们的信息,请参阅贡献指南中的 联系我们 部分。

您还可以在 Ansible 沟通指南 中找到更多信息。

贡献

如果您想贡献,请阅读 贡献指南

行为准则

请参阅 Ansible 社区行为准则

许可

由于使用了如 ansibleyamllint 这样的 GPLv3 运行时依赖项,ansible-lint 项目以 GPLv3 分发。

出于历史原因,其代码库仍受更自由的 MIT 许可证的保护,并且任何贡献都视为在原始 MIT 许可证下做出。

作者

ansible-lint 由 Will Thames 创建,并由 Ansible 项目由 Red Hat 维护。

项目详情


发布历史 发布通知 | RSS 源

下载文件

下载您平台对应的文件。如果您不确定该选择哪个,请了解有关安装包的更多信息。

源分发

ansible_lint-24.9.2.tar.gz (536.2 kB 查看散列值)

上传时间

构建分发

ansible_lint-24.9.2-py3-none-any.whl (307.9 kB 查看散列值)

上传时间 Python 3

支持者