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-aws-lambda-layer

# Tags of this project
tags:
  - aws
  - aws-lambda
  - aws-lambda-layer
  - terraform
  - terraform-modules

# Categories of this project
categories:
  - terraform-modules/supported

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: enter-at/terraform-aws-lambda-layer

# Badges to display
badges:
  - name: "Build Status"
    image: "https://github.com/enter-at/terraform-aws-lambda-layer/workflows/Code%20checks%20and%20tests/badge.svg"
    url: "https://github.com/enter-at/terraform-aws-lambda-layer/actions"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/enter-at/terraform-aws-lambda-layer.svg"
    url: "https://github.com/enter-at/terraform-aws-lambda-layer/releases/latest"
  - name: "Semantic Release"
    image: "https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg"
    url: "https://github.com/semantic-release/semantic-release"

related:
  - name: "terraform-aws-lambda"
    description: "Terraform module designed to facilitate the creation of AWS Lambda functions."
    url: "https://github.com/enter-at/terraform-aws-lambda"

# Short description of this project
description: |-
  Terraform module designed to facilitate the creation of AWS Lambda layers.

# How to use this project
usage: |-
  ### Simple Example

  ```hcl
  module "layer" {
    source = "git::https://github.com/enter-at/terraform-aws-lambda-layer.git?ref=main"
    layer_name   = "dependencies"
    package_file = "../Pipfile"
  }
  ```

  ### Advanced Example

  ```hcl
  module "layer" {
    source = "git::https://github.com/enter-at/terraform-aws-lambda-layer.git?ref=main"
    layer_name   = "dependencies"
    source_dir   = "../src/lib"
    source_type  = "python"

    rsync_pattern = [
      "--exclude='**tests**'",
      "--exclude='**__pycache__**'",
      "--include=module/{a,b,c}/",
      "--include='*.py'",
      "--exclude='module/*'"
    ]
  }
  ```

  ### Example on Ruby Gem layer

  ```hcl
  module "layer" {
    source = "git::https://github.com/enter-at/terraform-aws-lambda-layer.git?ref=main"
    layer_name   = "dependencies"
    source       = "."
    package_file = "Gemfile"
    compatible_runtimes = ["ruby2.7"]
  }
  ```

  Note the following

  * The package includes the following directory structure ruby/*ruby\_version*/...
  * The ruby directory contains Gemfile/Gemfile.lock. These are included for referential integrity
    You will may want to symlink these together with your `lambda_function`

  ```sh
  # In your script for packing lambda function
  ln -sf /opt/ruby/Gemfile Gemfile
  ln -sf /opt/ruby/Gemfile.lock Gemfile.lock
  ```

include:
  - "docs/terraform.md"