devopsinfra/action-format-hcl

HCL文件格式化GitHub Action

概述和主要用途

GitHub Action，用于自动格式化所有HCL（HashiCorp配置语言）和TF（Terraform）文件，支持.hcl、.tf、.tfvars扩展名。适用于需要确保配置文件格式一致性的基础设施即代码（IaC）管理场景。

核心功能和特性

• 基于devopsinfra/docker-terragrunt框架的精简镜像构建
• 适用于所有使用Terraform或Terragrunt的IaC管理环境
• 集成了cytopia/docker-terragrunt-fmt工具的包装器，实现高效格式化

可用平台

• Docker Hub：https://hub.docker.com/repository/docker/devopsinfra/action-format-hcl
• GitHub Packages：https://github.com/devops-infra/action-format-hcl/pkgs/container/action-format-hcl

徽章

!GitHub repo !GitHub last commit !GitHub code size in bytes !GitHub license
!DockerHub !Docker version !Image size !Docker Pulls

API参考

yaml
    - name: 运行Action
      uses: devops-infra/action-format-hcl@v1.0.0
      with:
        list: false
        write: true
        ignore: config
        diff: false
        check: false
        recursive: true
        dir: modules

输入参数

使用示例

基本示例

检查格式错误文件，发现问题时Action会失败：

yaml
name: 检查HCL格式
on:
  push
jobs:
  format-hcl:
    runs-on: ubuntu-latest
    steps:
    - name: 检出代码
      uses: actions/checkout@v5

    - name: 检查格式错误文件
      uses: devops-infra/action-format-hcl@v1.0.0
      with:
        check: true

高级示例

自动格式化HCL文件并提交更改：

yaml
name: 格式化HCL文件
on:
  push
jobs:
  format-hcl:
    runs-on: ubuntu-latest
    steps:
    - name: 检出代码
      uses: actions/checkout@v5

    - name: 格式化HCL文件
      uses: devops-infra/action-format-hcl@v1.0.0

    - name: 提交更改到仓库
      uses: devops-infra/action-commit-push@v1
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        commit_prefix: "[AUTO-FORMAT-HCL]"

相关Action

• https://github.com/devops-infra/action-commit-push - 用于提交并推送更改到Git仓库

贡献

欢迎贡献！详见https://github.com/devops-infra/.github/blob/master/CONTRIBUTING.md%E3%80%82%E6%9C%AC%E9%A1%B9%E7%9B%AE%E9%87%87%E7%94%A8MIT%E8%AE%B8%E5%8F%AF%E8%AF%81 - 详见LICENSE文件。

许可证

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

支持

如有问题或需要帮助：

• 创建https://github.com/devops-infra/action-format-hcl/issues
• 若觉得有用，请给本仓库点赞！