generate docs

.github/workflows/docs.yaml

@@ -0,0 +1,43 @@
+name: Documentation
+
+on:
+  pull_request:
+    paths:
+      - 'internal/provider/**'
+      - 'templates/**'
+      - 'examples/**'
+      - '.github/workflows/docs.yaml'
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+      - uses: actions/[email protected]
+        with:
+          go-version-file: "go.mod"
+          cache: true
+      - uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3.1.2
+        with:
+          terraform_version: "1.5.7"
+          terraform_wrapper: false
+      - name: Generate documentation
+        run: |
+          go mod download
+          go generate ./...
+      - name: Check for documentation changes
+        run: |
+          if ! git diff --exit-code docs/; then
+            echo "Documentation is out of date. Please run 'make docs' and commit the changes."
+            git diff docs/
+            exit 1
+          fi
+      - name: Validate documentation
+        run: |
+          go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs validate

.github/workflows/release.yaml

@@ -25,6 +25,10 @@ jobs:
         with:
           terraform_version: "1.5.7"
           terraform_wrapper: false
+      - name: Generate documentation
+        run: |
+          go mod download
+          go generate ./...
       - name: Import GPG key
         uses: crazy-max/[email protected]
         id: import_gpg

.goreleaser.yml

@@ -57,6 +57,7 @@ release:
   extra_files:
     - glob: "terraform-registry-manifest.json"
       name_template: "{{ .ProjectName }}_{{ .Version }}_manifest.json"
+    - glob: "docs/**/*"
   # If you want to manually examine the release before its live, uncomment this line:
   # draft: true
 

.tfplugindocs.yml

@@ -0,0 +1,9 @@
+provider_name: "grafbase"
+rendered_provider_name: "Grafbase"
+rendered_website_dir: "docs"
+examples_dir: "examples"
+exclude_deprecated: true
+exclude_beta: false
+website_source_dir: "templates"
+website_temp_dir: ".tfplugindocs"
+tf_version: "1.5"

README.md

@@ -331,6 +331,26 @@ make dev-setup  # Setup development environment
 make debug      # Run provider in debug mode
 ```
 
+### Documentation
+
+The provider documentation is automatically generated from the code using `tfplugindocs`:
+
+```bash
+make docs       # Generate documentation from code
+```
+
+The documentation is generated from:
+- Provider and resource schemas defined in the Go code
+- Template files in the `templates/` directory
+- Example configurations in the `examples/` directory
+
+Documentation files are created in the `docs/` directory and are automatically included in releases for publication to the Terraform Registry.
+
+To validate documentation:
+```bash
+go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs validate
+```
+
 ### Testing
 
 #### Unit Tests

go.mod

@@ -9,13 +9,23 @@ require (
 )
 
 require (
+	github.com/BurntSushi/toml v1.2.1 // indirect
+	github.com/Kunde21/markdownfmt/v3 v3.1.0 // indirect
+	github.com/Masterminds/goutils v1.1.1 // indirect
+	github.com/Masterminds/semver/v3 v3.2.0 // indirect
+	github.com/Masterminds/sprig/v3 v3.2.3 // indirect
 	github.com/ProtonMail/go-crypto v1.1.6 // indirect
 	github.com/agext/levenshtein v1.2.2 // indirect
 	github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect
+	github.com/armon/go-radix v1.0.0 // indirect
+	github.com/bgentry/speakeasy v0.1.0 // indirect
+	github.com/bmatcuk/doublestar/v4 v4.8.1 // indirect
 	github.com/cloudflare/circl v1.6.1 // indirect
 	github.com/fatih/color v1.16.0 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/go-cmp v0.7.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/hashicorp/cli v1.1.7 // indirect
 	github.com/hashicorp/errwrap v1.1.0 // indirect
 	github.com/hashicorp/go-checkpoint v0.5.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
@@ -31,26 +41,37 @@ require (
 	github.com/hashicorp/logutils v1.0.0 // indirect
 	github.com/hashicorp/terraform-exec v0.23.0 // indirect
 	github.com/hashicorp/terraform-json v0.25.0 // indirect
+	github.com/hashicorp/terraform-plugin-docs v0.22.0 // indirect
 	github.com/hashicorp/terraform-plugin-log v0.9.0 // indirect
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.37.0 // indirect
 	github.com/hashicorp/terraform-registry-address v0.2.5 // indirect
 	github.com/hashicorp/terraform-svchost v0.1.1 // indirect
 	github.com/hashicorp/yamux v0.1.1 // indirect
+	github.com/huandu/xstrings v1.3.3 // indirect
+	github.com/imdario/mergo v0.3.15 // indirect
 	github.com/kr/pretty v0.3.0 // indirect
 	github.com/mattn/go-colorable v0.1.14 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-runewidth v0.0.9 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/go-testing-interface v1.14.1 // indirect
 	github.com/mitchellh/go-wordwrap v1.0.0 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/oklog/run v1.0.0 // indirect
-	github.com/rogpeppe/go-internal v1.13.1 // indirect
+	github.com/posener/complete v1.2.3 // indirect
+	github.com/rogpeppe/go-internal v1.14.1 // indirect
+	github.com/shopspring/decimal v1.3.1 // indirect
+	github.com/spf13/cast v1.5.0 // indirect
 	github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
 	github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect
 	github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
+	github.com/yuin/goldmark v1.7.7 // indirect
+	github.com/yuin/goldmark-meta v1.1.0 // indirect
 	github.com/zclconf/go-cty v1.16.3 // indirect
+	go.abhg.dev/goldmark/frontmatter v0.2.0 // indirect
 	golang.org/x/crypto v0.39.0 // indirect
+	golang.org/x/exp v0.0.0-20230626212559-97b1e661b5df // indirect
 	golang.org/x/mod v0.25.0 // indirect
 	golang.org/x/net v0.40.0 // indirect
 	golang.org/x/sync v0.15.0 // indirect
@@ -61,4 +82,6 @@ require (
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20250218202821-56aae31c358a // indirect
 	google.golang.org/grpc v1.72.1 // indirect
 	google.golang.org/protobuf v1.36.6 // indirect
+	gopkg.in/yaml.v2 v2.3.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )