README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-provider-utils

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Copyrights
copyrights:
  - name: "Cloud Posse, LLC"
    url: "https://cloudposse.com"
    year: "2021"

# Canonical GitHub repo
github_repo: cloudposse/terraform-provider-utils

# Badges to display
badges:
  - name: Tests
    image: https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-provider-utils/test.yml?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-utils/actions/workflows/test.yml

# List any related terraform modules that this module may be used with or that this module depends on.
  - name: Tests
    image: https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-provider-utils/test.yml?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-utils/actions/workflows/test.yml

# List any related terraform modules that this module may be used with or that this module depends on.
  - name: Tests
    image: https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-provider-utils/test.yml?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-utils/actions/workflows/test.yml

# List any related terraform modules that this module may be used with or that this module depends on.
  - name: Tests
    image: https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-provider-utils/test.yml?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-utils/actions/workflows/test.yml

# List any related terraform modules that this module may be used with or that this module depends on.
  - name: Tests
    image: https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-provider-utils/test.yml?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-utils/actions/workflows/test.yml

# List any related terraform modules that this module may be used with or that this module depends on.
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-provider-utils.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-utils/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-provider-utils.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-utils/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com
  - name: Tests
    image: https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-provider-utils/test.yml?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-utils/actions/workflows/test.yml

# List any related terraform modules that this module may be used with or that this module depends on.
related:

# List any resources helpful for someone to get started. For example, link to the hashicorp documentation or AWS documentation.
references:
  - name: "Terraform Plugins"
    description: "Terraform is logically split into two main parts: Terraform Core and Terraform Plugins. Each plugin exposes an implementation for a specific service, such as the AWS provider or the cloud-init provider."
    url: "https://www.terraform.io/docs/extend/plugin-types.html#providers"

# Short description of this project
description: |-
  Terraform provider for various utilities (deep merging, Atmos stack configuration management), and to add additional missing functionality to Terraform

#introduction: |-
#  This is an introduction.

# How to use this module. Should be an easy example to copy and paste.
usage: |-
  Here is how to use this provider in your own Terraform code:

  ```hcl
  terraform {
    required_providers {
      utils = {
        source = "cloudposse/utils"
        version = ">= 1.17.0"
      }
    }
  }
  ```

  See the [Docs](./docs) for additional information.

# Example usage
examples: |-
  Here is an example of using this provider:

  ```hcl
  terraform {
    required_providers {
      utils = {
        source = "cloudposse/utils"
      }
    }
  }

  locals {
    yaml_data_1 = file("${path.module}/data1.yaml")
    yaml_data_2 = file("${path.module}/data2.yaml")
  }

  data "utils_deep_merge_yaml" "example" {
    input = [
      local.yaml_data_1,
      local.yaml_data_2
    ]
  }

  output "deep_merge_output" {
    value = data.utils_deep_merge_yaml.example.output
  }
  ```

  Here are some additional examples:

  - [`examples/data-sources/utils_deep_merge_json`](examples/data-sources/utils_deep_merge_json)
  - [`examples/data-sources/utils_deep_merge_yaml`](examples/data-sources/utils_deep_merge_yaml)

include:
  - "docs/developer.md"

# Contributors to this project
contributors: []