action.yml

name: terraform-docs
author: Derek Rada
description: A Github action for generating terraform module documentation using terraform-docs and gomplate.
inputs:
  tf_docs_working_dir:
    description: Directories of terraform modules to generate docs for seperated by commas (conflicts with atlantis/find dirs)
    required: false
    default: '.'
  tf_docs_atlantis_file:
    description: Generate directories by parsing an atlantis formatted yaml to enable provide the file name to parse (eg atlantis.yaml)
    required: false
    default: 'disabled'
  tf_docs_find_dir:
    description: Generate directories by running find ./tf_docs_find_dir -name *.tf
    required: false
    default: 'disabled'
  tf_docs_output_file:
    description: File in module directory where the docs should be placed
    required: false
    default: 'USAGE.md'
  tf_docs_content_type:
    description: Generate document or table
    required: false
    default: 'table'
  tf_docs_indention:
    description: Indention level of Markdown sections [1, 2, 3, 4, 5]
    required: false
    default: '2'
  tf_docs_args:
    description: Additional args to pass to the command see https://github.com/segmentio/terraform-docs/tree/master/docs
    required: false
    default: ''
  tf_docs_output_method:
    description: Method should be one of (replace/inject/print) where replace will replace the tf_docs_output_file, inject will inject the content between start and close delims and print will just print the output
    required: false
    default: 'inject'
  tf_docs_git_push:
    description: If true it will commit and push the changes
    required: false
    default: 'false'
  tf_docs_git_commit_message:
    description: Commit message
    required: false
    default: 'terraform-docs: automated action'
  tf_docs_template:
    description: When provided will be used as the template if/when the OUTPUT_FILE does not exist
    default: |
      # Usage
      <!--- BEGIN_TF_DOCS --->
      <!--- END_TF_DOCS --->
    required: false

outputs:
  num_changed:
    description: Number of files changed

runs:
  using: docker
  image: Dockerfile

branding:
  icon: file-text
  color: gray-dark