From 9ffd76bf0f43375a09f4ee0dedaed46ac14c151d Mon Sep 17 00:00:00 2001 From: David Arnold <10138997+djaboxx@users.noreply.github.com> Date: Wed, 25 Sep 2024 12:23:59 -0700 Subject: [PATCH] Add README.md --- README.md | 49 +------------------------------------------------ 1 file changed, 1 insertion(+), 48 deletions(-) diff --git a/README.md b/README.md index d70d65a..ff548a6 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,2 @@ - -## Requirements -No requirements. - -## Providers - -| Name | Version | -|------|---------| -| [github](#provider\_github) | 6.2.3 | -| [local](#provider\_local) | 2.5.1 | -| [null](#provider\_null) | 3.2.2 | - -## Modules - -No modules. - -## Resources - -| Name | Type | -|------|------| -| [github_actions_runner_group.rg](https://registry.terraform.io/providers/hashicorp/github/latest/docs/resources/actions_runner_group) | resource | -| [local_file.env](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource | -| [local_file.supervisorctl](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource | -| [null_resource.install_runner](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource | -| [null_resource.register_runner](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource | -| [null_resource.supervisorctl_reload](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource | -| [github_actions_registration_token.token](https://registry.terraform.io/providers/hashicorp/github/latest/docs/data-sources/actions_registration_token) | data source | -| [github_repository.repository](https://registry.terraform.io/providers/hashicorp/github/latest/docs/data-sources/repository) | data source | - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [autorestart](#input\_autorestart) | n/a | `bool` | `true` | no | -| [env\_vars](#input\_env\_vars) | Environment variables to set for the runners | `map(string)` | `{}` | no | -| [github\_base\_url](#input\_github\_base\_url) | Base URL for the GitHub API | `string` | `"https://api.github.com"` | no | -| [github\_owner](#input\_github\_owner) | Owner of the repositories | `string` | n/a | yes | -| [removal\_tokens](#input\_removal\_tokens) | Map of repository to token for removing runners | `map(string)` | `{}` | no | -| [repos](#input\_repos) | List of repositories to add runners to | `list(string)` | `[]` | no | -| [runner\_basedir](#input\_runner\_basedir) | Base directory for the runners | `string` | `"/opt/actions-runner"` | no | -| [runner\_group](#input\_runner\_group) | Runner group to add runners to | `string` | `null` | no | -| [runner\_labels](#input\_runner\_labels) | Labels to assign to the runner | `list(string)` | `[]` | no | -| [runner\_tarball](#input\_runner\_tarball) | Path to the runner tarball | `string` | n/a | yes | - -## Outputs - -No outputs. - \ No newline at end of file +[![Terraform Validation](https://github.com/HappyPathway/terraform-ghe-runner/actions/workflows/terraform.yaml/badge.svg)](https://github.com/HappyPathway/terraform-ghe-runner/actions/workflows/terraform.yaml)