README.yaml

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

# Name of this project
name: "test-harness"

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

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: "cloudposse/test-harness"

# Badges to display
badges:
- name: "Codefresh Build Status"
  image: "https://g.codefresh.io/api/badges/pipeline/cloudposse/cloudposse%2Ftest-harness%2Ftest-harness?type=cf-1"
  url: "https://g.codefresh.io/public/accounts/cloudposse/pipelines/cloudposse/test-harness/test-harness"
- name: "Latest Release"
  image: "https://img.shields.io/github/release/cloudposse/test-harness.svg"
  url: "https://github.com/cloudposse/test-harness/releases/latest"
- name: "Slack Community"
  image: "https://slack.cloudposse.com/badge.svg"
  url: "https://slack.cloudposse.com"

references:
- name: "Cloud Posse Documentation"
  description: "Complete documentation for the Cloud Posse solution"
  url: "https://docs.cloudposse.com"

# Short description of this project
description: |-
  Collection of Makefiles and test scripts to facilitate testing Terraform modules, Kubernetes resources, Helm charts, and more.

  ## Prerequisites

  1. [Bats-core](https://github.com/bats-core/bats-core)
  1. Bash v5+
    - If you're on Mac, you're possibly running Bash v3. You can upgrade via homebrew: `brew install bash`

# How to use this project
usage: |-
  Use the `test-harness` Docker image as the base image in the application `Dockerfile`, and copy the modules from `tests` folder into `/tests/` folder in the Docker container.

  ```dockerfile
  FROM cloudposse/test-harness:0.25.0 as test-harness

  # Get latest release from https://github.com/cloudposse/geodesic/releases
  FROM cloudposse/geodesic:2.11.3-alpine

  # Copy root modules into /conf folder
  COPY --from=test-harness /tests/ /tests/
  ```

include:
- "docs/targets.md"

# Contributors to this project
contributors:
- name: "Erik Osterman"
  github: "osterman"
- name: "Andriy Knysh"
  github: "aknysh"
- name: "Igor Rodionov"
  github: "goruha"