feat: prepare for release 2.1.1

.github/workflows/terraform-docs.yaml

@@ -3,13 +3,13 @@
   workflow_call:
     inputs:
       config_file:
-        description: The path to the configuration file.
         default: '.terraform-docs.yml'
+        description: The path to the configuration file.
         required: false
         type: string
       git_push:
-        description: If set to true, push the changes to the repository.
         default: false
+        description: If set to true, push the changes to the repository.
         required: false
         type: boolean
       jobs_run_on:
@@ -18,13 +18,13 @@
         required: false
         type: string
       output_file:
-        description: The path to the output file.
         default: 'README.md'
+        description: The path to the output file.
         required: false
         type: string
       output_method:
-        description: The method to use for output.
         default: 'inject'
+        description: The method to use for output.
         required: false
         type: string
       terragrunt_directory:
@@ -33,8 +33,8 @@
         required: false
         type: string
       timeout_minutes:
-        description: The maximum time (in minutes) for a job to run.
         default: 5
+        description: The maximum time (in minutes) for a job to run.
         required: false
         type: number
       use_terragrunt:
@@ -43,10 +43,10 @@
         required: false
         type: boolean
       working_directory:
+        default: '.'
         description: |
           The working directory where all jobs should be executed.
           Comma separated list of directories to generate docs for.
-        default: '.'
         required: false
         type: string
 
@@ -84,9 +84,9 @@ jobs:
       - name: Render terraform docs inside the README.md
         uses: terraform-docs/[email protected]
         with:
-          working-dir: ${{ inputs.working_directory }}
           config-file: ${{ inputs.config_file }}
+          git-push: ${{ inputs.git_push }}
           output-file: ${{ inputs.output_file }}
           output-method: ${{ inputs.output_method }}
-          git-push: ${{ inputs.git_push }}
+          working-dir: ${{ inputs.working_directory }}
     timeout-minutes: ${{ inputs.timeout_minutes }}

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
           - -b main
       - id: trailing-whitespace
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.33.0
+    rev: v1.35.1
     hooks:
       - id: yamllint
         args:

CHANGELOG.md

@@ -1,8 +1,19 @@
 # Changelog
 
-## [2.1.0](https://github.com/broadinstitute/shared-workflows/tree/2.1.0) (2024-01-30)
+## [2.1.1](https://github.com/broadinstitute/shared-workflows/tree/2.1.1) (2024-02-26)
 
-[Full Changelog](https://github.com/broadinstitute/shared-workflows/compare/v2.0.1...2.1.0)
+[Full Changelog](https://github.com/broadinstitute/shared-workflows/compare/v2.1.0...2.1.1)
+
+**Implemented enhancements:**
+
+- build\(deps\): bump the actions group with 1 update [\#59](https://github.com/broadinstitute/shared-workflows/pull/59) ([dependabot[bot]](https://github.com/apps/dependabot))
+- feat: Adding Terraform Docs [\#44](https://github.com/broadinstitute/shared-workflows/pull/44) ([tfhartmann](https://github.com/tfhartmann))
+- build\(deps\): bump the actions group with 2 updates [\#43](https://github.com/broadinstitute/shared-workflows/pull/43) ([dependabot[bot]](https://github.com/apps/dependabot))
+- build\(deps\): bump the actions group with 1 update [\#42](https://github.com/broadinstitute/shared-workflows/pull/42) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v2.1.0](https://github.com/broadinstitute/shared-workflows/tree/v2.1.0) (2024-01-30)
+
+[Full Changelog](https://github.com/broadinstitute/shared-workflows/compare/v2.0.1...v2.1.0)
 
 **Implemented enhancements:**
 

README.md

@@ -203,6 +203,21 @@ install any [Python][5] dependencies.
 * `test_targets`: A list of directories to target for testing.
 [green](https://github.com/CleanCut/green) will autodetect if left blank. Default: ``
 
+### terraform-docs.yaml
+
+This workflow will setup and run [terraform-docs](https://terraform-docs.io/) to
+generate the [Terraform][10] documentation and store it in the README.md.
+
+#### terraform-docs Inputs
+
+* `config_file`: The path to the configuration file. Default: `.terraform-docs.yml`
+* `git_push`: If set to true, push the changes to the repository. Default: `false`
+* `output_file`: The path to the output file. Default: `README.md`
+* `output_method`: The method to use for output. Default: `inject`
+* `terragrunt_directory`: The environment directory from which Terragrunt should run.
+  Default: `prod`
+* `use_terragrunt`: If set to true, use Terragrunt instead of Terraform. Default: `false`
+
 ### terraform-lint.yaml
 
 This workflow will setup and run