feat: migrate to tfplugindocs auto-generated documentation

GNUmakefile

@@ -84,4 +84,15 @@ ifeq (,$(wildcard $(GOPATH)/src/$(WEBSITE_REPO)))
 endif
 	@$(MAKE) -C $(GOPATH)/src/$(WEBSITE_REPO) website-provider-test PROVIDER_PATH=$(shell pwd) PROVIDER_NAME=$(PKG_NAME)
 
-.PHONY: build test testacc fmt lint lintcheck tools website website-lint website-test sweep
+docs-generate:
+	go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name github
+
+docs-validate:
+	go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs validate
+
+docs-migrate:
+	go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs migrate --provider-name github \
+		--templates-dir templates \
+		--examples-dir examples
+
+.PHONY: build test testacc fmt lint lintcheck tools website website-lint website-test sweep docs-generate docs-validate docs-migrate

website/docs/d/actions_environment_public_key.html.markdown → docs/data-sources/actions_environment_public_key.md

@@ -1,19 +1,16 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_environment_public_key"
 description: |-
   Get information on a GitHub Actions Environment Public Key.
 ---
 
 # github_actions_environment_public_key
 
-Use this data source to retrieve information about a GitHub Actions public key of a specific environment. This data source is required to be used with other GitHub secrets interactions.
-Note that the provider `token` must have admin rights to a repository to retrieve the action public keys of it's environments.
-
+Use this data source to retrieve information about a GitHub Actions public key of a specific environment. This data source is required to be used with other GitHub secrets interactions. Note that the provider `token` must have admin rights to a repository to retrieve the action public keys of it's environments.
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_environment_public_key" "example" {
   repository = "example_repo"
   environment = "example_environment"
@@ -22,10 +19,10 @@ data "github_actions_environment_public_key" "example" {
 
 ## Argument Reference
 
- * `repository` - (Required) Name of the repository to get public key from.
- * `environment` - (Required) Name of the environment to get public key from.
+* `repository` - (Required) Name of the repository to get public key from.
+* `environment` - (Required) Name of the environment to get public key from.
 
 ## Attributes Reference
 
- * `key_id` - ID of the key that has been retrieved.
- * `key`    - Actual key retrieved.
+* `key_id` - ID of the key that has been retrieved.
+* `key` - Actual key retrieved.

website/docs/d/actions_environment_secrets.html.markdown → docs/data-sources/actions_environment_secrets.md

@@ -1,5 +1,4 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_environment_secrets"
 description: |-
   Get Actions secrets of the repository environment
@@ -11,7 +10,7 @@ Use this data source to retrieve the list of secrets of the repository environme
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_environment_secrets" "example" {
     name        = "exampleRepo"
     environment = "exampleEnvironment"
@@ -22,7 +21,7 @@ data "github_actions_environment_secrets" "example" {
 
 ## Attributes Reference
 
- * `secrets` - list of secrets for the environment
-   * `name`         - Name of the secret
-   * `created_at`   - Timestamp of the secret creation
-   * `updated_at`   - Timestamp of the secret last update
+* `secrets` - list of secrets for the environment
+  * `name` - Name of the secret
+  * `created_at` - Timestamp of the secret creation
+  * `updated_at` - Timestamp of the secret last update

website/docs/d/actions_environment_variables.html.markdown → docs/data-sources/actions_environment_variables.md

@@ -1,5 +1,4 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_environment_variables"
 description: |-
   Get Actions variables of the repository environment
@@ -11,7 +10,7 @@ Use this data source to retrieve the list of variables of the repository environ
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_environment_variables" "example" {
     name        = "exampleRepo"
     environment = "exampleEnvironment"
@@ -22,8 +21,8 @@ data "github_actions_environment_variables" "example" {
 
 ## Attributes Reference
 
- * `variables` - list of variables for the environment
-   * `name`         - Name of the variable
-   * `value`        - Value of the variable
-   * `created_at`   - Timestamp of the variable creation
-   * `updated_at`   - Timestamp of the variable last update
+* `variables` - list of variables for the environment
+  * `name` - Name of the variable
+  * `value` - Value of the variable
+  * `created_at` - Timestamp of the variable creation
+  * `updated_at` - Timestamp of the variable last update

website/docs/d/actions_organization_oidc_subject_claim_customization_template.html.markdown → docs/data-sources/actions_organization_oidc_subject_claim_customization_template.md

@@ -1,5 +1,4 @@
 ---
-layout: "github"
 page_title: "GitHub: actions_organization_oidc_subject_claim_customization_template"
 description: |-
   Get a GitHub Actions organization OpenID Connect customization template
@@ -11,7 +10,7 @@ Use this data source to retrieve the OpenID Connect subject claim customization
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_organization_oidc_subject_claim_customization_template" "example" {
 }
 ```
@@ -20,4 +19,4 @@ data "github_actions_organization_oidc_subject_claim_customization_template" "ex
 
 ## Attributes Reference
 
- * `include_claim_keys` - The list of OpenID Connect claim keys.
+* `include_claim_keys` - The list of OpenID Connect claim keys.

website/docs/d/actions_organization_public_key.html.markdown → docs/data-sources/actions_organization_public_key.md

@@ -1,22 +1,20 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_organization_public_key"
 description: |-
   Get information on a GitHub Actions Organization Public Key.
 ---
 
 # github_actions_organization_public_key
 
-Use this data source to retrieve information about a GitHub Actions Organization public key. This data source is required to be used with other GitHub secrets interactions.
-Note that the provider `token` must have admin rights to an organization to retrieve it's action public key.
+Use this data source to retrieve information about a GitHub Actions Organization public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider `token` must have admin rights to an organization to retrieve it's action public key.
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_organization_public_key" "example" {}
 ```
 
 ## Attributes Reference
 
- * `key_id` - ID of the key that has been retrieved.
- * `key`    - Actual key retrieved.
+* `key_id` - ID of the key that has been retrieved.
+* `key` - Actual key retrieved.

website/docs/d/actions_organization_registration_token.html.markdown → docs/data-sources/actions_organization_registration_token.md

@@ -1,5 +1,4 @@
 ---
-layout: "github"
 page_title: "GitHub: actions_organization_registration_token"
 description: |-
   Get a GitHub Actions organization registration token.
@@ -11,7 +10,7 @@ Use this data source to retrieve a GitHub Actions organization registration toke
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_organization_registration_token" "example" {
 }
 ```
@@ -20,5 +19,5 @@ data "github_actions_organization_registration_token" "example" {
 
 ## Attributes Reference
 
- * `token` - The token that has been retrieved.
- * `expires_at` - The token expiration date.
+* `token` - The token that has been retrieved.
+* `expires_at` - The token expiration date.

website/docs/d/actions_organization_secrets.html.markdown → docs/data-sources/actions_organization_secrets.md

@@ -1,5 +1,4 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_organization_secrets"
 description: |-
   Get actions secrets of the organization
@@ -11,7 +10,7 @@ Use this data source to retrieve the list of secrets of the organization.
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_organization_secrets" "example" {
 }
 ```
@@ -20,9 +19,8 @@ data "github_actions_organization_secrets" "example" {
 
 ## Attributes Reference
 
- * `secrets` - list of secrets for the repository
-   * `name` - Secret name
-   * `visibility` - Secret visibility
-   * `created_at` - Timestamp of the secret creation
-   * `updated_at` - Timestamp of the secret last update
-
+* `secrets` - list of secrets for the repository
+  * `name` - Secret name
+  * `visibility` - Secret visibility
+  * `created_at` - Timestamp of the secret creation
+  * `updated_at` - Timestamp of the secret last update

website/docs/d/actions_organization_variables.html.markdown → docs/data-sources/actions_organization_variables.md

@@ -1,5 +1,4 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_organization_variables"
 description: |-
   Get Actions variables of the organization
@@ -11,7 +10,7 @@ Use this data source to retrieve the list of variables of the organization.
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_organization_variables" "example" {
 }
 ```
@@ -20,9 +19,9 @@ data "github_actions_organization_variables" "example" {
 
 ## Attributes Reference
 
- * `variables` - list of variables for the repository
-   * `name`         - Name of the variable
-   * `value`        - Value of the variable
-   * `visibility`   - Visibility of the variable
-   * `created_at`   - Timestamp of the variable creation
-   * `updated_at`   - Timestamp of the variable last update
+* `variables` - list of variables for the repository
+  * `name` - Name of the variable
+  * `value` - Value of the variable
+  * `visibility` - Visibility of the variable
+  * `created_at` - Timestamp of the variable creation
+  * `updated_at` - Timestamp of the variable last update

website/docs/d/actions_public_key.html.markdown → docs/data-sources/actions_public_key.md

@@ -1,29 +1,26 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_public_key"
 description: |-
   Get information on a GitHub Actions Public Key.
 ---
 
 # github_actions_public_key
 
-Use this data source to retrieve information about a GitHub Actions public key. This data source is required to be used with other GitHub secrets interactions.
-Note that the provider `token` must have admin rights to a repository to retrieve it's action public key.
+Use this data source to retrieve information about a GitHub Actions public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider `token` must have admin rights to a repository to retrieve it's action public key.
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_public_key" "example" {
   repository = "example_repo"
 }
 ```
 
 ## Argument Reference
 
- * `repository` - (Required) Name of the repository to get public key from.
+* `repository` - (Required) Name of the repository to get public key from.
 
 ## Attributes Reference
 
- * `key_id` - ID of the key that has been retrieved.
- * `key`    - Actual key retrieved.
-
+* `key_id` - ID of the key that has been retrieved.
+* `key` - Actual key retrieved.

website/docs/d/actions_registration_token.html.markdown → docs/data-sources/actions_registration_token.md

@@ -1,5 +1,4 @@
 ---
-layout: "github"
 page_title: "GitHub: actions_registration_token"
 description: |-
   Get a GitHub Actions repository registration token.
@@ -11,17 +10,17 @@ Use this data source to retrieve a GitHub Actions repository registration token.
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_registration_token" "example" {
   repository = "example_repo"
 }
 ```
 
 ## Argument Reference
 
- * `repository` - (Required) Name of the repository to get a GitHub Actions registration token for.
+* `repository` - (Required) Name of the repository to get a GitHub Actions registration token for.
 
 ## Attributes Reference
 
- * `token` - The token that has been retrieved.
- * `expires_at` - The token expiration date.
+* `token` - The token that has been retrieved.
+* `expires_at` - The token expiration date.

website/docs/d/actions_repository_oidc_subject_claim_customization_template.html.markdown → docs/data-sources/actions_repository_oidc_subject_claim_customization_template.md

@@ -1,5 +1,4 @@
 ---
-layout: "github"
 page_title: "GitHub: actions_repository_oidc_subject_claim_customization_template"
 description: |-
   Get a GitHub Actions repository's OpenID Connect customization template
@@ -11,7 +10,7 @@ Use this data source to retrieve the OpenID Connect subject claim customization
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_repository_oidc_subject_claim_customization_template" "example" {
   name = "example_repository"
 }
@@ -23,5 +22,5 @@ data "github_actions_repository_oidc_subject_claim_customization_template" "exam
 
 ## Attributes Reference
 
- * `use_default`        - Whether the repository uses the default template.
- * `include_claim_keys` - The list of OpenID Connect claim keys.
+* `use_default` - Whether the repository uses the default template.
+* `include_claim_keys` - The list of OpenID Connect claim keys.

website/docs/d/actions_secrets.html.markdown → docs/data-sources/actions_secrets.md

@@ -1,5 +1,4 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_secrets"
 description: |-
   Get actions secrets for a repository
@@ -11,21 +10,20 @@ Use this data source to retrieve the list of secrets for a GitHub repository.
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_secrets" "example" {
   name = "example"
 }
 ```
 
 ## Argument Reference
 
- * `name` - (Optional) The name of the repository.
- * `full_name` - (Optional) Full name of the repository (in `org/name` format).
+* `name` - (Optional) The name of the repository.
+* `full_name` - (Optional) Full name of the repository (in `org/name` format).
 
 ## Attributes Reference
 
- * `secrets` - list of secrets for the repository
-   * `name` - Secret name
-   * `created_at` - Timestamp of the secret creation
-   * `updated_at` - Timestamp of the secret last update
-
+* `secrets` - list of secrets for the repository
+  * `name` - Secret name
+  * `created_at` - Timestamp of the secret creation
+  * `updated_at` - Timestamp of the secret last update

docs/data-sources/actions_variables.md

@@ -0,0 +1,30 @@
+---
+page_title: "GitHub: github_actions_variables"
+description: |-
+  Get Actions variables for a repository
+---
+
+# github\_actions\_variables
+
+Use this data source to retrieve the list of variables for a GitHub repository.
+
+## Example Usage
+
+```terraform
+data "github_actions_variables" "example" {
+  name = "example"
+}
+```
+
+## Argument Reference
+
+* `name` - (Optional) The name of the repository.
+* `full_name` - (Optional) Full name of the repository (in `org/name` format).
+
+## Attributes Reference
+
+* `variables` - list of variables for the repository
+  * `name` - Name of the variable
+  * `value` - Value of the variable
+  * `created_at` - Timestamp of the variable creation
+  * `updated_at` - Timestamp of the variable last update