Skip to main content

Creating Automated Terraform Documentation


The Modernisation Platform use a Documentation GitHub Workflow to automate Terraform documentation. The workflow automatically searches then creates and populates tables using the variables, providers, modules, versions used in your Terraform code.

Configuration to run documentation workflow

1) Ensure you have a copy of documentation.yml in your .github/workflows/ directory.

2) Create a top-level file called in your repository.

3) Add the following two lines to your file:

<!--- BEGIN_TF_DOCS --->

<!--- END_TF_DOCS --->

4) The GitHub workflow will create the automated documentation in between these two tags and commit them when a pull request is created. You may include any custom markdown instructions outside of the tags.

This page was last reviewed on 9 May 2023. It needs to be reviewed again on 9 November 2023 by the page owner #modernisation-platform .
This page was set to be reviewed before 9 November 2023 by the page owner #modernisation-platform. This might mean the content is out of date.