cytopia/terragrunt-fmt

terragrunt-fmt Docker镜像

![License]([***]

https://github.com/cytopia/docker-terragrunt-fmt/workflows/lint/badge.svg](https://github.com/cytopia/docker-terragrunt-fmt/actions?query=workflow%3Alint) https://github.com/cytopia/docker-terragrunt-fmt/workflows/build/badge.svg](https://github.com/cytopia/docker-terragrunt-fmt/actions?query=workflow%3Abuild) https://github.com/cytopia/docker-terragrunt-fmt/workflows/nightly/badge.svg](https://github.com/cytopia/docker-terragrunt-fmt/actions?query=workflow%3Anightly)

所有 https://github.com/topics/awesome-ci Docker镜像

[ansible-lint][alint-git-lnk] • [ansible][ansible-git-lnk] • [awesome-ci][aci-git-lnk] • [bandit][bandit-git-lnk] • [black][black-git-lnk] • [checkmake][cm-git-lnk] • [eslint][elint-git-lnk] • [file-lint][flint-git-lnk] • [gofmt][gfmt-git-lnk] • [goimports][gimp-git-lnk] • [golint][glint-git-lnk] • [jsonlint][jlint-git-lnk] • [kubeval][kubeval-git-lnk] • [linkcheck][linkcheck-git-lnk] • [mypy][mypy-git-lnk] • [php-cs-fixer][pcsf-git-lnk] • [phpcbf][pcbf-git-lnk] • [phpcs][pcs-git-lnk] • [phplint][plint-git-lnk] • [pycodestyle][pycs-git-lnk] • [pydocstyle][pyds-git-lnk] • [pylint][pylint-git-lnk] • [terraform-docs][tfdocs-git-lnk] • [terragrunt-fmt][tgfmt-git-lnk] • [terragrunt][tg-git-lnk] • [yamlfmt][yfmt-git-lnk] • [yamllint][ylint-git-lnk]

查看GitHub上的**https://github.com/cytopia/docker-terragrunt-fmt/blob/master/Dockerfiles/**%E3%80%82

支持的架构： amd64, i386, arm64, arm/v7, arm/v6, ppc64le, s390x

基于Alpine的多阶段构建Docker镜像，集成了https://github.com/hashicorp/terraform^[1]，能够对Terragrunt文件（.hcl）执行terraform fmt格式化操作。通过在容器内创建带有.tf扩展名的临时文件实现此功能。此外，包装器扩展了**-ignore参数**，可用于忽略文件、目录或通配符匹配项。该镜像每晚基于多个稳定版本构建并推送到Dockerhub。

_{[1] 官方项目：https://github.com/hashicorp/terraform}

:whale: 可用的Docker镜像版本

滚动发布版本

以下Docker镜像标签为滚动发布版本，每晚构建并更新。

https://github.com/cytopia/docker-terragrunt-fmt/workflows/nightly/badge.svg](https://github.com/cytopia/docker-terragrunt-fmt/actions?query=workflow%3Anightly)

特定时间点发布版本

以下Docker镜像标签为一次性构建版本，可用于可重复构建。其版本不会更改，因此需要定期更新管道中的标签以保持最新。

https://github.com/cytopia/docker-terragrunt-fmt/workflows/build/badge.svg](https://github.com/cytopia/docker-terragrunt-fmt/actions?query=workflow%3Abuild)

其中 <tag> 指此仓库中选择的git标签。

:open_file_folder: Docker挂载

Docker容器内的工作目录为**/data/**，应将本地项目根目录挂载到此路径。

:computer: 使用方法

忽略所有名为dev/和testing/的目录及其内部所有内容：

bash
$ docker run --rm -v $(pwd):/data cytopia/terragrunt-fmt -recursive -ignore=*/dev/,*/testing/

[INFO] 查找文件: find . -not \( -path "./*/dev/*" -o -path "./*/testing/*" \) -name '*.hcl' -type f
terraform fmt -list=true -write=false ./prod/eu-central-1/microservice/terragrunt.hcl
../tmp/terragrunt.hcl.tf
terraform fmt -list=true -write=false ./prod/eu-central-1/infra/terragrunt.hcl
../tmp/terragrunt.hcl.tf

项目与CI集成

Makefile

可在项目中添加以下Makefile，以便轻松对Terragrunt .hcl文件进行代码检查和格式化修复：

make
ifneq (,)
.error This Makefile requires GNU Make.
endif

.PHONY: help lint fix _pull

CURRENT_DIR = $(dir $(abspath $(lastword $(MAKEFILE_LIST))))

# 根据需求调整
IGNORE      = */.terragrunt-cache/,*/.terraform/
FMT_VERSION = latest

help:
	@echo "help    显示此帮助信息"
	@echo "lint    若存在格式错误文件则退出状态码>0"
	@echo "fix     修复所有.hcl文件格式"

lint: _pull
	docker run --rm -v $(CURRENT_DIR):/data cytopia/terragrunt-fmt:$(FMT_VERSION) \
		-check -diff -recursive -ignore='$(IGNORE)'

fix: _pull
	docker run --rm -v $(CURRENT_DIR):/data cytopia/terragrunt-fmt:$(FMT_VERSION) \
		-write -diff -recursive -ignore='$(IGNORE)'

_pull:
	docker pull cytopia/terragrunt-fmt:$(FMT_VERSION)

Travis CI集成

有了上述Makefile后，可轻松添加Travis CI规则以确保Terragrunt代码使用正确的编码风格：

yml
---
sudo: required
language: minimal
services:
  - docker
script:
  - make lint

:arrows_counterclockwise: 相关 https://github.com/topics/awesome-ci 项目

Docker镜像

无需安装大量依赖，选择以下Docker化版本的代码检查工具，实现可重复的本地或远程CI测试：