docs: migrate provider docs to tfplugindocs

.github/workflows/ci.yaml

@@ -35,6 +35,6 @@ jobs:
           cache: true
       - run: make tools
       - run: make lintcheck
-      - run: make website-lint
+      - run: make docs-check
       - run: make build
       - run: make test

GNUmakefile

@@ -28,8 +28,8 @@ endif
 default: build
 
 tools:
-	go install github.com/client9/misspell/cmd/misspell@v0.3.4
 	go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.6.0
+	go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@v0.24.0
 
 build: lintcheck
 	CGO_ENABLED=0 go build -ldflags="-s -w" ./...
@@ -74,8 +74,22 @@ endif
 	@$(MAKE) -C $(GOPATH)/src/$(WEBSITE_REPO) website-provider PROVIDER_PATH=$(shell pwd) PROVIDER_NAME=$(PKG_NAME)
 
 website-lint:
-	@echo "==> Checking website against linters..."
-	@misspell -error -source=text website/
+	@$(MAKE) docs-check
+
+docs:
+	@echo "==> Generating provider docs..."
+	go generate ./...
+
+docs-validate:
+	@echo "==> Validating provider docs..."
+	go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs validate --provider-name $(PKG_NAME)
+
+docs-check: docs docs-validate
+	@echo "==> Checking provider docs for drift..."
+	@test -z "$$(git status --short --untracked-files=all -- docs templates examples main.go go.mod go.sum)" || \
+		( echo "Generated docs are out of date. Run 'make docs' and commit the results."; \
+		git status --short --untracked-files=all -- docs templates examples main.go go.mod go.sum; \
+		exit 1 )
 
 website-test:
 ifeq (,$(wildcard $(GOPATH)/src/$(WEBSITE_REPO)))
@@ -84,4 +98,4 @@ 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
+.PHONY: build test testacc fmt lint lintcheck tools website website-lint website-test docs docs-validate docs-check sweep

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

@@ -1,19 +1,17 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_environment_public_key"
 description: |-
   Get information on a GitHub Actions Environment Public Key.
+subcategory: "GitHub Actions"
 ---
 
 # 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 +20,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,8 +1,8 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_environment_secrets"
 description: |-
   Get Actions secrets of the repository environment
+subcategory: "GitHub Actions"
 ---
 
 # github\_actions\_environment\_secrets
@@ -11,7 +11,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 +22,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,8 +1,8 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_environment_variables"
 description: |-
   Get Actions variables of the repository environment
+subcategory: "GitHub Actions"
 ---
 
 # github\_actions\_environment\_variables
@@ -11,7 +11,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 +22,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,17 +1,17 @@
 ---
-layout: "github"
-page_title: "GitHub: actions_organization_oidc_subject_claim_customization_template"
+page_title: "GitHub: github_actions_organization_oidc_subject_claim_customization_template"
 description: |-
   Get a GitHub Actions organization OpenID Connect customization template
+subcategory: "GitHub Actions"
 ---
 
-# actions_organization_oidc_subject_claim_customization_template
+# github_actions_organization_oidc_subject_claim_customization_template
 
 Use this data source to retrieve the OpenID Connect subject claim customization template for an organization
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_organization_oidc_subject_claim_customization_template" "example" {
 }
 ```
@@ -20,4 +20,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,21 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_organization_public_key"
 description: |-
   Get information on a GitHub Actions Organization Public Key.
+subcategory: "GitHub Actions"
 ---
 
 # 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,17 +1,17 @@
 ---
-layout: "github"
-page_title: "GitHub: actions_organization_registration_token"
+page_title: "GitHub: github_actions_organization_registration_token"
 description: |-
   Get a GitHub Actions organization registration token.
+subcategory: "GitHub Actions"
 ---
 
-# actions_registration_token
+# github_actions_organization_registration_token
 
 Use this data source to retrieve a GitHub Actions organization registration token. This token can then be used to register a self-hosted runner.
 
 ## Example Usage
 
-```hcl
+```terraform
 data "github_actions_organization_registration_token" "example" {
 }
 ```
@@ -20,5 +20,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,8 +1,8 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_organization_secrets"
 description: |-
   Get actions secrets of the organization
+subcategory: "GitHub Actions"
 ---
 
 # github\_actions\_organization\_secrets
@@ -11,7 +11,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 +20,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,8 +1,8 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_organization_variables"
 description: |-
   Get Actions variables of the organization
+subcategory: "GitHub Actions"
 ---
 
 # github\_actions\_organization\_variables
@@ -11,7 +11,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 +20,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,27 @@
 ---
-layout: "github"
 page_title: "GitHub: github_actions_public_key"
 description: |-
   Get information on a GitHub Actions Public Key.
+subcategory: "GitHub Actions"
 ---
 
 # 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,27 +1,27 @@
 ---
-layout: "github"
-page_title: "GitHub: actions_registration_token"
+page_title: "GitHub: github_actions_registration_token"
 description: |-
   Get a GitHub Actions repository registration token.
+subcategory: "GitHub Actions"
 ---
 
-# actions_registration_token
+# github_actions_registration_token
 
 Use this data source to retrieve a GitHub Actions repository registration token. This token can then be used to register a self-hosted runner.
 
 ## 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.