Skip to content

Inclusão do Terraform-docs na pipeline Terraform #35

@estacaodati

Description

@estacaodati

Dependencias

N/A

Feature Request

Adicionar o terraform-docs para gerar a documentação dos código terraform e dos módulos. Isso ajuda a ter controle de versão do código que está sendo implementado e suas dependências.

DoD

  • Incluir terraform-docs nas pipelines do terraform
  • Incluir uma flag para gerar ou não a documentação
  • Incluir uma flag para incluir ou não os módulos/submodulos
  • Incluir opção para gerar a documentação em um diretório específico e caso não seja inclusa, definir o working_directory como saida default

Documentação:
https://terraform-docs.io/
https://terraform-docs.io/how-to/github-action/

Exemplo de como fica a documentação:
https://github.com/estacaodati/tf-docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions