chore(docs): update Terraform docs and add terraform-docs workflow

.github/workflows/terraform-docs.yaml

@@ -0,0 +1,15 @@
+name: Update Terraform documentation
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  terraform-docs:
+    name: Update Terraform documentation
+    uses: canonical/operator-workflows/.github/workflows/generate_terraform_docs.yaml@main
+    secrets: inherit
+    with:
+      terraform-directory: terraform/charm,terraform/product

terraform/charm/README.md

@@ -57,3 +57,48 @@ The complete list of available integrations can be found [in the Integrations ta
 [Terraform Juju provider]: https://registry.terraform.io/providers/juju/juju/latest
 [Juju]: https://juju.is
 [github-runner-integrations]: https://charmhub.io/github-runner/integrations
+
+<!-- BEGIN_TF_DOCS -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_juju"></a> [juju](#requirement\_juju) | >= 0.11.0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_juju"></a> [juju](#provider\_juju) | >= 0.11.0 |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [juju_application.github_runner](https://registry.terraform.io/providers/juju/juju/latest/docs/resources/application) | resource |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_app_name"></a> [app\_name](#input\_app\_name) | Name of the application in the Juju model. | `string` | `"github-runner"` | no |
+| <a name="input_base"></a> [base](#input\_base) | The operating system on which to deploy | `string` | `"ubuntu@22.04"` | no |
+| <a name="input_channel"></a> [channel](#input\_channel) | The channel to use when deploying a charm. | `string` | `"latest/stable"` | no |
+| <a name="input_config"></a> [config](#input\_config) | Application config. Details about available options can be found at https://charmhub.io/github-runner/configurations | `map(string)` | `{}` | no |
+| <a name="input_constraints"></a> [constraints](#input\_constraints) | Juju constraints to apply for this application. | `string` | `""` | no |
+| <a name="input_model"></a> [model](#input\_model) | Reference to a `juju_model`. | `string` | `""` | no |
+| <a name="input_revision"></a> [revision](#input\_revision) | Revision number of the charm | `number` | `null` | no |
+| <a name="input_units"></a> [units](#input\_units) | Number of units to deploy | `number` | `1` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_app_name"></a> [app\_name](#output\_app\_name) | Name of the deployed application. |
+| <a name="output_provides"></a> [provides](#output\_provides) | n/a |
+| <a name="output_requires"></a> [requires](#output\_requires) | n/a |
+<!-- END_TF_DOCS -->

terraform/product/README.md

@@ -20,3 +20,48 @@ the bundle deployment onto any Kubernetes environment managed by [Juju][Juju].
 [Juju]: https://juju.is
 [Github runner charm]: https://charmhub.io/github-runner
 [Github runner image builder charm]: https://charmhub.io/github-runner-image-builder
+
+<!-- BEGIN_TF_DOCS -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_juju"></a> [juju](#requirement\_juju) | >= 0.11.0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_juju"></a> [juju](#provider\_juju) | >= 0.11.0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_github_runner"></a> [github\_runner](#module\_github\_runner) | ../charm | n/a |
+| <a name="module_github_runner_image_builder"></a> [github\_runner\_image\_builder](#module\_github\_runner\_image\_builder) | git::https://github.com/canonical/github-runner-image-builder-operator//terraform/charm | rev67 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [juju_integration.image_builder](https://registry.terraform.io/providers/juju/juju/latest/docs/resources/integration) | resource |
+| [juju_model.github_runner](https://registry.terraform.io/providers/juju/juju/latest/docs/data-sources/model) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_github_runner_image_builder"></a> [github\_runner\_image\_builder](#input\_github\_runner\_image\_builder) | n/a | <pre>object({<br/>    app_name    = optional(string, "github-runner-image-builder")<br/>    channel     = optional(string, "latest/stable")<br/>    config      = optional(map(string), {})<br/>    constraints = optional(string, "arch=amd64 cores=2 mem=8192M root-disk=20000M")<br/>    revision    = optional(number)<br/>    base        = optional(string, "ubuntu@22.04")<br/>    units       = optional(number, 1)<br/>  })</pre> | n/a | yes |
+| <a name="input_github_runners"></a> [github\_runners](#input\_github\_runners) | n/a | <pre>list(object({<br/>    app_name    = optional(string, "github-runner")<br/>    channel     = optional(string, "latest/stable")<br/>    config      = optional(map(string), {})<br/>    constraints = optional(string, "arch=amd64 cores=2 mem=8192M root-disk=20000M")<br/>    revision    = optional(number)<br/>    base        = optional(string, "ubuntu@22.04")<br/>    units       = optional(number, 1)<br/>  }))</pre> | n/a | yes |
+| <a name="input_model"></a> [model](#input\_model) | Reference to the Juju model to deploy the github-runner and github-runner-image-builder operators. | `string` | n/a | yes |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_all_app_names"></a> [all\_app\_names](#output\_all\_app\_names) | Names of the all the deployed apps, github-runner plus github-runner-image-builder. |
+| <a name="output_all_runner_names"></a> [all\_runner\_names](#output\_all\_runner\_names) | Names of the all the deployed github-runner applications. |
+| <a name="output_github_runner_image_builder_app_name"></a> [github\_runner\_image\_builder\_app\_name](#output\_github\_runner\_image\_builder\_app\_name) | Name of the the deployed github-runner-image-builder application. |
+| <a name="output_reactive_runner_names"></a> [reactive\_runner\_names](#output\_reactive\_runner\_names) | Names of the all the deployed github-runner applications that are reactive. |
+<!-- END_TF_DOCS -->