devopsinfra/action-tflint

🚀 用于检查Terraform文件的GitHub Action

用于在Terraform文件上运行TFlint的GitHub Action。

📦 可用位置

• Docker Hub: https://hub.docker.com/repository/docker/devopsinfra/action-tflint
• GitHub Packages: https://github.com/orgs/devops-infra/packages/container/package/action-tflint

✨ 特性

• 主要用于所有使用https://github.com/hashicorp/terraform%E7%9A%84%E5%9C%BA%E6%99%AF%EF%BC%8C%E7%89%B9%E5%88%AB%E9%80%82%E7%94%A8%E4%BA%8E%E9%9D%99%E6%80%81%E6%88%96%E4%B8%BB%E5%8A%A8%E6%A3%80%E6%9F%A5%E6%A8%A1%E5%9D%97%E6%BA%90%E3%80%82
• 使用https://github.com/wata727%E5%BC%80%E5%8F%91%E7%9A%84https://github.com/terraform-linters/tflint%E3%80%82

📊 徽章

🏷️ 版本标签：vX、vX.Y、vX.Y.Z

此Action支持三种标签级别以实现灵活版本控制：

• vX：主版本的最新补丁（例如 v1）。
• vX.Y：次版本的最新补丁（例如 v1.2）。
• vX.Y.Z：固定到特定版本（例如 v1.2.3）。

📖 API参考

yaml
    - name: Run the Action
      uses: devops-infra/action-tflint@v1.0.0
      with:
        dir_filter: modules

🔧 输入参数

💻 使用示例

📝 基础示例

默认情况下，如果在任何子目录中发现 lint 错误则失败。通过GitHub运行此Action。

yaml
name: Check TFLint
on:
  push:
    branches:
      - "**"
jobs:
  format-hcl:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v5

    - name: Check linting of Terraform files
      uses: devops-infra/action-tflint@v1.0.0

🔀 高级示例（自定义配置）

使用不同位置的TFLint配置文件，并仅解析modules/目录下的aws*和gcp*模块。通过GitHub运行此Action。

yaml
name: Check TFLint with custom config
on:
  push:
    branches:
      - "**"
jobs:
  format-hcl:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v5

    - name: Check linting of Terraform modules
      uses: devops-infra/action-tflint@v1.0.0
      with:
        tflint_config: modules/.tflint.hcl
        dir_filter: modules/aws,modules/gcp

🔀 高级示例（深度检查）

使用深度检查（需要云凭证），并将modules下的所有目录视为Terraform模块。通过DockerHub运行此Action。

yaml
name: Check TFLint with custom config
on:
  push:
    branches:
      - "**"
jobs:
  format-hcl:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v5

    - name: Check linting of Terraform modules
      uses: devops-infra/action-tflint@v1.0.0
      with:
        tflint_params: "--module --deep"
        dir_filter: modules

🤝 贡献

欢迎贡献！详见https://github.com/devops-infra/.github/blob/master/CONTRIBUTING.md%E3%80%82 本项目采用MIT许可证 - 详见LICENSE文件了解详情。

📄 许可证

本项目采用MIT许可证 - 详见LICENSE文件了解详情。

💬 支持

如果您有任何问题或需要帮助，请：

• 📝 创建https://github.com/devops-infra/action-tflint/issues
• 🌟 如果觉得有用，请给本仓库点星！