feat: implement basic provider for supabase project settings (#2)

* feat: initialise supabase api client

* feat: define branch data source

* feat: implement settings resource

* fix: use jsontypes for parsing config

* chore: reinitialise go mod dependencies

* chore: remove duplicate ci runs

* chore: update readme with provider example

* chore: regenerate docs

* fix: access set of project branches

* chore: update docs

* fix: remove sensitive value

* fix: destroy orphan resource

Author: sweatybridge

.github/CODEOWNERS

@@ -1 +1 @@
-* @hashicorp/terraform-devex
+* @supabase/cli

.github/workflows/test.yml

@@ -8,6 +8,8 @@ on:
     paths-ignore:
       - 'README.md'
   push:
+    branches:
+      - main
     paths-ignore:
       - 'README.md'
 

README.md

@@ -2,7 +2,7 @@
 
 _This template repository is built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework). The template repository built on the [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk) can be found at [terraform-provider-scaffolding](https://github.com/hashicorp/terraform-provider-scaffolding). See [Which SDK Should I Use?](https://developer.hashicorp.com/terraform/plugin/framework-benefits) in the Terraform documentation for additional information._
 
-This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:
+This repository is a _template_ for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:
 
 - A resource and a data source (`internal/provider/`),
 - Examples (`examples/`) and generated documentation (`docs/`),
@@ -45,7 +45,56 @@ Then commit the changes to `go.mod` and `go.sum`.
 
 ## Using the provider
 
-Fill this in for each provider
+- main.tf
+
+```hcl
+terraform {
+  required_providers {
+    supabase = {
+      source  = "supabase/supabase"
+      version = "~> 1.0"
+    }
+  }
+}
+
+provider "supabase" {
+  access_token = file("${path.module}/access-token")
+}
+
+# Define a linked project variable as user input
+variable "linked_project" {
+  type    = string
+}
+
+# Configure api settings for the linked project
+resource "supabase_settings" "production" {
+  project_ref = var.linked_project
+
+  api = jsonencode({
+    db_schema            = "public,storage,graphql_public"
+    db_extra_search_path = "public,extensions"
+    max_rows             = 1000
+  })
+}
+
+# Fetch all branches of a linked project
+data "supabase_branch" "all" {
+  parent_project_ref = var.linked_project
+}
+
+# Override settings for each preview branch
+resource "supabase_settings" "branch" {
+  for_each = { for b in data.supabase_branch.all.branches : b.project_ref => b }
+
+  project_ref = each.key
+
+  api = jsonencode({
+    db_schema            = "public,storage,graphql_public"
+    db_extra_search_path = "public,extensions"
+    max_rows             = 100
+  })
+}
+```
 
 ## Developing the Provider
 
@@ -57,7 +106,7 @@ To generate or update documentation, run `go generate`.
 
 In order to run the full suite of Acceptance tests, run `make testacc`.
 
-*Note:* Acceptance tests create real resources, and often cost money to run.
+_Note:_ Acceptance tests create real resources, and often cost money to run.
 
 ```shell
 make testacc

docs/data-sources/branch.md

@@ -0,0 +1,39 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "supabase_branch Data Source - terraform-provider-supabase"
+subcategory: ""
+description: |-
+  Branch data source
+---
+
+# supabase_branch (Data Source)
+
+Branch data source
+
+## Example Usage
+
+```terraform
+data "supabase_branch" "all" {
+  parent_project_ref = "mayuaycdtijbctgqbycg"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `parent_project_ref` (String) Parent project ref
+
+### Read-Only
+
+- `branches` (Attributes Set) Branch databases (see [below for nested schema](#nestedatt--branches))
+
+<a id="nestedatt--branches"></a>
+### Nested Schema for `branches`
+
+Read-Only:
+
+- `git_branch` (String) Git branch
+- `id` (String) Branch identifier
+- `project_ref` (String) Branch project ref

docs/data-sources/scaffolding_example.md

@@ -1,20 +1,20 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "scaffolding-framework Provider"
+page_title: "supabase Provider"
 subcategory: ""
 description: |-
   
 ---
 
-# scaffolding-framework Provider
+# supabase Provider
 
 
 
 ## Example Usage
 
 ```terraform
-provider "scaffolding" {
-  # example configuration here
+provider "supabase" {
+  access_token = ""
 }
 ```
 
@@ -23,4 +23,5 @@ provider "scaffolding" {
 
 ### Optional
 
-- `endpoint` (String) Example provider attribute
+- `access_token` (String, Sensitive) Supabase access token
+- `endpoint` (String) Supabase API endpoint

docs/index.md

@@ -0,0 +1,43 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "supabase_settings Resource - terraform-provider-supabase"
+subcategory: ""
+description: |-
+  Settings resource
+---
+
+# supabase_settings (Resource)
+
+Settings resource
+
+## Example Usage
+
+```terraform
+resource "supabase_settings" "production" {
+  project_ref = "mayuaycdtijbctgqbycg"
+
+  api = jsonencode({
+    db_schema            = "public,storage,graphql_public"
+    db_extra_search_path = "public,extensions"
+    max_rows             = 1000
+  })
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project_ref` (String) Project reference ID
+
+### Optional
+
+- `api` (String) API settings as [serialised JSON](https://api.supabase.com/api/v1#/services/updatePostgRESTConfig)
+- `auth` (String) Auth settings as [serialised JSON](https://api.supabase.com/api/v1#/projects%20config/updateV1AuthConfig)
+- `pooler` (String) Pooler settings as serialised JSON
+- `storage` (String) Storage settings as serialised JSON
+
+### Read-Only
+
+- `id` (String) Project identifier

docs/resources/scaffolding_example.md

@@ -0,0 +1,3 @@
+data "supabase_branch" "all" {
+  parent_project_ref = "mayuaycdtijbctgqbycg"
+}