Files
Khosrow Moossavi 8f74fd4453 feat: ignore outputs, providers, resources with comments
Prepend any type of resource, including `resource`, `data`, `module`,
`variable`, and `output` with a comment including "terraform-docs-ignore"
to exclude it from the generated output.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
2024-05-30 12:33:14 -04:00

52 lines
865 B
HCL

/**
* Example of 'foo_bar' module in `foo_bar.tf`.
*
* - list item 1
* - list item 2
*
* Even inline **formatting** in _here_ is possible.
* and some [link](https://domain.com/)
*/
terraform {
required_version = ">= 0.12"
required_providers {
aws = ">= 2.15.0"
}
}
resource "tls_private_key" "baz" {}
data "aws_caller_identity" "current" {
provider = "aws"
}
# terraform-docs-ignore
data "aws_caller_identity" "ignored" {
provider = "aws"
}
resource "null_resource" "foo" {}
# terraform-docs-ignore
resource "null_resource" "ignored" {}
module "foo" {
source = "bar"
version = "1.2.3"
}
module "foobar" {
source = "git@github.com:module/path?ref=v7.8.9"
}
locals {
arn = provider::aws::arn_parse("arn:aws:iam::444455556666:role/example")
}
// terraform-docs-ignore
module "ignored" {
source = "baz"
version = "1.2.3"
}