github.com/Azure/tflint-ruleset-azurerm-ext@v0.6.0/README.md (about) 1 # TFLint Ruleset for terraform-provider-azurerm-ext 2 3 ![test](https://img.shields.io/github/actions/workflow/status/Azure/tflint-ruleset-azurerm-ext/build.yml) 4 ![lint](https://img.shields.io/github/actions/workflow/status/Azure/tflint-ruleset-azurerm-ext/lint.yaml) 5 ![e2e](https://img.shields.io/github/actions/workflow/status/Azure/tflint-ruleset-azurerm-ext/e2e.yaml) 6 7 TFLint ruleset extension plugin for Terraform Provider for Azure (Resource Manager) 8 9 ## Requirements 10 11 - TFLint v0.35+ 12 - Go v1.18 13 14 ## Building the plugin 15 16 Clone the repository locally and run the following command: 17 18 ``` 19 $ make 20 ``` 21 22 You can easily install the built plugin with the following: 23 24 ``` 25 $ make install 26 ``` 27 28 To utilize the lastest Azure API info (this may cause incompatibility with current plugin version): 29 30 ``` 31 $ make updateSubmodule 32 $ make install 33 ``` 34 35 Note that if you install the plugin with make install, you must omit the `version` and `source` attributes in `.tflint.hcl`: 36 37 ```hcl 38 plugin "azurerm-ext" { 39 enabled = true 40 } 41 ``` 42 43 If you install the plugin with `tflint --init`, you must specify the following content in `.tflint.hcl`: 44 ```hcl 45 plugin "azurerm-ext" { 46 enabled = true 47 version = "0.0.1" 48 source = "github.com/DrikoldLun/tflint-ruleset-azurerm-ext" 49 signing_key = <<-KEY 50 -----BEGIN PGP PUBLIC KEY BLOCK----- 51 52 mQGNBGLtC9wBDADUty0QYzsGe7+Q1e2slFNFw6+SVQKvj+/K3CGrKt1sl8evPLOy 53 Q+kNUmCtTSunPgRlxPWICNa/QiV5AhR5Jn7B0o92OG8LjHJ1ThrvzbHVDyCkKPb/ 54 PzpsSNjnWVxZV3uTO3brzaUOn9nbmfOGBtJQc4V2a9U8Z8X3WVh2LCn3qXb6xRtM 55 SP/DIccZHChMQpgYheh3kZIPOvRyLA4Kp8MRB1MOi44aQyfneOA5ryVa7yLNHn1h 56 QyKQ0HiGGnCjYS5NEtyBWtzm2xRWEmJRWydsDDDvBLI+44ymhriwZUrS8FVUgiYo 57 GjIGp6JOxP/V3HqfCP22I1sfheXFX4jzr0qWasKYGoSn9CoAUxvoO1k19jLCL3cV 58 Fw1JC26wIHlTE9GBLNWklgfBJapK34Iqwy9Q5SAuw6gi5ZoGN5kVMqmzWacsxcZZ 59 MAAhOdSwOsGNx/Zx6D2eJ8BWsybvdz8RQ3AXx7YCGSwHgNbcgjjRKNQlxs8X60XN 60 bQYip6Xu8V2S3Y0AEQEAAbQjTHVuIFpoYW5nIDx6aGFuZ2xuanUyMDE1QGdtYWls 61 LmNvbT6JAdEEEwEIADsWIQSNp1KuIvc/Uuj2uScp5xG7/lWJIgUCYu0L3AIbAwUL 62 CQgHAgIiAgYVCgkICwIEFgIDAQIeBwIXgAAKCRAp5xG7/lWJIjZxC/0SG46lBuyj 63 8og2fdcCTiKdI1IllIjKnrHjh1Hp92ohfD+N9Q729qwN7CmC/MSlhLB2bTUn6HZ0 64 Pp6Go+h5V0mGO9CtN15icbvhEpO+k48wGLfX9qNfc5Wod2a8zkyTZ2ZAlEudxEwT 65 A7mdpGhi6zLCnsSlC+/A293KnzyIm3/8GwZbOoGBmPOFYb2FLCRvIupFj+VcOsDz 66 5ZnmrLVNSC69dDmcXRqRpgdd60J7wS093qqsd0G67Mj7FCxOc4BLfDMKE/MYSJmq 67 xRpFak6hjQVYGmUQhkyu+pPAdz+oR5fRCDwlmjtClnTE2IfP6bi4IX3+g+s3GJU0 68 bHSh1ImWUvnjJ/G/ZmeYtWWAxt1ZzJj0fjnF6nS+uzh/9bstY4EklMd8cY5v/vmU 69 ittjB1KH5IJueDHL5JNoWi0tJVh8vSLuM3HbZ7yWfvE+uaextyfpOPJmIt+z5yOM 70 4MHeu12TCIxKrSkdq/Z+3b1FWQTUDPDBr/41fpt22H+Lxf4F2Jcn7Tc= 71 =T2nt 72 -----END PGP PUBLIC KEY BLOCK----- 73 KEY 74 } 75 ``` 76 77 If you want to specify the ignore/retain filename patterns for some rules in this plugin, write the following ignore config in `.tflintignore.azurerm-ext.json`: 78 ```json 79 { 80 "azurerm_resource_tag" : [ 81 "^*$", 82 "!^main\\.tf$" 83 ] 84 } 85 ``` 86 The pattern regular expression follows Go syntax, and the prefix `!` means the file with such name pattern would still be checked. 87 88 Follow the instructions to edit the generated files and open a new pull request.