added linting and formatting

Author: KT-Doan

.github/PULL_REQUEST_TEMPLATE.md

@@ -20,7 +20,7 @@ Fixes #(issue number)
 - [ ] I have added tests that prove my fix/feature works
 - [ ] I have updated documentation as needed
 - [ ] All new and existing tests pass (`make test`)
-- [ ] I have run the linter (`make lint`)
+- [ ] I have run the linter (`make format`)
 
 ## Testing
 

.github/workflows/lint.yml

@@ -12,106 +12,21 @@ permissions:
 jobs:
   format:
     name: Format
-    runs-on: ubuntu-slim
+    runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-      - name: Setup Go
-        uses: actions/setup-go@v5
+      - uses: actions/setup-go@v5
         with:
           go-version-file: 'go.mod'
           cache: true
 
-      - name: Setup Terraform
-        uses: hashicorp/setup-terraform@v3
+      - uses: hashicorp/setup-terraform@v3
         with:
           terraform_wrapper: false
 
-      - name: Run formatters
-        run: make fmt-all
-
-      - name: Check for formatting changes
-        run: |
-          if ! git diff --exit-code; then
-            echo ""
-            echo "Files are not formatted correctly. Run 'make fmt-all' and commit the changes."
-            echo ""
-            git diff --stat
-            exit 1
-          fi
-
-  lint:
-    name: Lint
-    runs-on: ubuntu-slim
-    timeout-minutes: 10
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Go
-        uses: actions/setup-go@v5
-        with:
-          go-version-file: 'go.mod'
-          cache: true
-
-      - name: Run golangci-lint
-        uses: golangci/golangci-lint-action@v6
-        with:
-          version: v2.0.2
-          args: --timeout=5m
-
-  mod-tidy:
-    name: Go Mod Tidy
-    runs-on: ubuntu-slim
-    timeout-minutes: 10
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Go
-        uses: actions/setup-go@v5
-        with:
-          go-version-file: 'go.mod'
-          cache: true
-
-      - name: Run go mod tidy
-        run: go mod tidy
-
-      - name: Check for changes
-        run: |
-          if ! git diff --exit-code go.mod go.sum; then
-            echo ""
-            echo "go.mod or go.sum is out of date. Run 'go mod tidy' and commit the changes."
-            exit 1
-          fi
-
-  docs:
-    name: Documentation
-    runs-on: ubuntu-slim
-    timeout-minutes: 10
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Go
-        uses: actions/setup-go@v5
-        with:
-          go-version-file: 'go.mod'
-          cache: true
-
-      - name: Install tfplugindocs
-        run: go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest
-
-      - name: Generate docs
-        run: tfplugindocs generate
+      - run: make format
 
       - name: Check for changes
-        run: |
-          if ! git diff --exit-code docs/; then
-            echo ""
-            echo "Documentation is out of date. Run 'make docs' and commit the changes."
-            git diff --stat docs/
-            exit 1
-          fi
+        run: git diff HEAD --exit-code --color

Makefile

@@ -55,81 +55,21 @@ clean: ## Remove build artifacts
 # CODE QUALITY
 # ==============================================================================
 
-.PHONY: fmt
-fmt: ## Format Go code
+.PHONY: format
+format: ## Format all code (Go, Terraform, modules, docs, lint fixes)
 	go fmt ./...
 	gofmt -s -w .
-
-.PHONY: fmt-check
-fmt-check: ## Check Go code formatting (fails if not formatted)
-	@if [ -n "$$(gofmt -l .)" ]; then \
-		echo "The following files are not formatted correctly:"; \
-		gofmt -l .; \
-		echo ""; \
-		echo "Run 'make fmt' to fix."; \
-		exit 1; \
-	fi
-
-.PHONY: fmt-tf
-fmt-tf: ## Format Terraform example files
 	terraform fmt -recursive examples/
-
-.PHONY: fmt-tf-check
-fmt-tf-check: ## Check Terraform formatting (fails if not formatted)
-	@if ! terraform fmt -check -recursive examples/; then \
-		echo ""; \
-		echo "Terraform files in examples/ are not formatted correctly."; \
-		echo "Run 'make fmt-tf' to fix."; \
-		exit 1; \
-	fi
-
-.PHONY: fmt-all
-fmt-all: fmt fmt-tf ## Format all code (Go and Terraform)
+	go mod tidy
+	@command -v tfplugindocs >/dev/null 2>&1 || { echo "Installing tfplugindocs..."; go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest; }
+	tfplugindocs generate --provider-name ory
+	@command -v golangci-lint >/dev/null 2>&1 || { echo "Installing golangci-lint..."; go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest; }
+	golangci-lint run --fix ./... || true
 
 .PHONY: lint
-lint: ## Run Go linter
+lint: ## Run Go linter (without fixes)
 	golangci-lint run ./...
 
-.PHONY: lint-tf
-lint-tf: fmt-tf-check ## Check Terraform formatting (alias for fmt-tf-check)
-
-.PHONY: vet
-vet: ## Run go vet
-	go vet ./...
-
-.PHONY: generate
-generate: ## Generate documentation and code
-	go generate ./...
-
-.PHONY: docs
-docs: ## Generate Terraform documentation
-	@command -v tfplugindocs >/dev/null 2>&1 || { echo "Installing tfplugindocs..."; go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest; }
-	tfplugindocs generate
-
-.PHONY: docs-check
-docs-check: docs ## Check if documentation is up to date
-	@if ! git diff --exit-code docs/; then \
-		echo "Documentation is out of date. Run 'make docs' and commit the changes."; \
-		exit 1; \
-	fi
-
-.PHONY: mod-tidy
-mod-tidy: ## Tidy go modules
-	go mod tidy
-
-.PHONY: mod-check
-mod-check: mod-tidy ## Check if go.mod/go.sum are up to date
-	@if ! git diff --exit-code go.mod go.sum; then \
-		echo "go.mod or go.sum is out of date. Run 'go mod tidy' and commit the changes."; \
-		exit 1; \
-	fi
-
-.PHONY: check
-check: fmt-all vet lint ## Format and run all code quality checks
-
-.PHONY: ci
-ci: fmt-check fmt-tf-check lint mod-check docs-check ## Run all CI checks (matches GitHub Actions, fails on issues)
-
 # ==============================================================================
 # TESTING
 # ==============================================================================

docs/data-sources/project.md

@@ -1,20 +1,19 @@
 ---
-page_title: "ory_project Data Source - Ory"
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "ory_project Data Source - ory"
 subcategory: ""
 description: |-
   Fetches information about an Ory project.
 ---
 
 # ory_project (Data Source)
 
-Fetches information about an Ory project. Use this data source to read project details without managing the project lifecycle.
+Fetches information about an Ory project.
 
 ## Example Usage
 
-### Read Current Project
-
 ```terraform
-# Read the project configured in the provider
+# Read the current project (from provider config)
 data "ory_project" "current" {}
 
 output "project_name" {
@@ -24,25 +23,27 @@ output "project_name" {
 output "project_slug" {
   value = data.ory_project.current.slug
 }
-```
 
-### Read Specific Project
+output "project_state" {
+  value = data.ory_project.current.state
+}
 
-```terraform
+# Read a specific project by ID
 data "ory_project" "other" {
   id = "other-project-uuid"
 }
 ```
 
+<!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Optional
 
-- `id` (String) - Project ID to look up. If not specified, uses the provider's project_id.
+- `id` (String) Project ID to look up. If not specified, uses the provider's project_id.
 
 ### Read-Only
 
-- `name` (String) - The project name.
-- `slug` (String) - The project slug.
-- `state` (String) - The project state.
-- `workspace_id` (String) - The workspace ID the project belongs to.
+- `name` (String) The project name.
+- `slug` (String) The project slug.
+- `state` (String) The project state.
+- `workspace_id` (String) The workspace ID the project belongs to.