Add formatting check to CI/CD (#2601)

## Changes
<!-- Brief summary of your changes that is easy to understand -->
1. Add new steps to CI/CD workflow to check formatting issues
2. Introduce a new make target: fmtcheck, which allows to check
formatting without writing changes to disk
3. Run auto formatter on existing files to make the check pass

## Why
<!-- Why are these changes needed? Provide the context that the reviewer
might be missing.
For example, were there any decisions behind the change that are not
reflected in the code itself? -->

With the migration to golangci-lint v2.x, we lost automatic checks of
code formatters configured with it in `.golangci.yaml`. This PR restores
these checks.

## Tests
<!-- How have you tested the changes? -->
Lint step is passing

<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->

---------

Co-authored-by: shreyas-goenka <88374338+shreyas-goenka@users.noreply.github.com>

Author: anton-107

.github/workflows/push.yml

@@ -96,16 +96,23 @@ jobs:
         run: |
           # Exit with status code 1 if there are differences (i.e. unformatted files)
           git diff --exit-code
-      - name: golangci-lint
+      - name: Run Go lint checks (does not include formatting checks)
         uses: golangci/golangci-lint-action@1481404843c368bc19ca9406f87d6e0fc97bdcfd # v7.0.0
         with:
           version: v2.0.2
           args: --timeout=15m
-      - name: Run ruff
+      - name: Run ruff (Python linter and formatter)
         uses: astral-sh/ruff-action@f14634c415d3e63ffd4d550a22f037df4c734a60 # v3.1.0
         with:
           version: "0.9.1"
           args: "format --check"
+      - name: Run formatting (does not include linting checks)
+        run: |
+          make fmt
+      - name: Fail on formatting differences
+        run: |
+          # Exit with status code 1 if there are differences (i.e. unformatted files)
+          git diff --exit-code
       - name: Run whitespace check
         run: python tools/validate_whitespace.py
 

Makefile

@@ -16,9 +16,6 @@ tidy:
 lintcheck:
 	golangci-lint run ./...
 
-# Note 'make lint' will do formatting as well. However, if there are compilation errors,
-# formatting/goimports will not be applied by 'make lint'. However, it will be applied by 'make fmt'.
-# If you need to ensure that formatting & imports are always fixed, do "make fmt lint"
 fmt:
 	ruff format -qn
 	golangci-lint fmt

bundle/internal/tf/codegen/schema/generate.go

@@ -15,7 +15,7 @@ import (
 )
 
 func (s *Schema) writeTerraformBlock(_ context.Context) error {
-	var body = map[string]any{
+	body := map[string]any{
 		"terraform": map[string]any{
 			"required_providers": map[string]any{
 				"databricks": map[string]any{
@@ -31,12 +31,12 @@ func (s *Schema) writeTerraformBlock(_ context.Context) error {
 		return err
 	}
 
-	return os.WriteFile(filepath.Join(s.WorkingDir, "main.tf.json"), buf, 0644)
+	return os.WriteFile(filepath.Join(s.WorkingDir, "main.tf.json"), buf, 0o644)
 }
 
 func (s *Schema) installTerraform(ctx context.Context) (path string, err error) {
 	installDir := filepath.Join(s.WorkingDir, "bin")
-	err = os.MkdirAll(installDir, 0755)
+	err = os.MkdirAll(installDir, 0o755)
 	if err != nil {
 		return
 	}
@@ -82,7 +82,7 @@ func (s *Schema) generateSchema(ctx context.Context, execPath string) error {
 		return err
 	}
 
-	return os.WriteFile(s.ProviderSchemaFile, buf, 0644)
+	return os.WriteFile(s.ProviderSchemaFile, buf, 0o644)
 }
 
 func (s *Schema) Generate(ctx context.Context) error {

bundle/internal/tf/codegen/schema/schema.go

@@ -25,7 +25,7 @@ func New() (*Schema, error) {
 	}
 
 	tmpdir := filepath.Join(wd, "./tmp")
-	err = os.MkdirAll(tmpdir, 0755)
+	err = os.MkdirAll(tmpdir, 0o755)
 	if err != nil {
 		return nil, err
 	}