Enforce no trailing whitespace (#4845)

## Changes

This mirrors databricks/cli#2603.

I ran into this when working on `jobs/resource_job_test.go`. My editor
trims trailing whitespace on save and I got a dozen diffs related to
this. Enforcing no trailing whitespace reduces this noise.

## Tests

- `make ws` is run for PRs to ensure new code doesn't violate this
- The VS Code settings are updated to trim trailing whitespace on save.

<!--
NO_CHANGELOG=true
//-->

Author: pietern

.codegen.json

@@ -13,4 +13,4 @@
             "make test"
         ]
     }
-}
+}

.devcontainer/Dockerfile

@@ -18,7 +18,7 @@ RUN \
     && apt-get clean -y \
     && rm -rf /var/lib/apt/lists/*
 
-# Install terraform 
+# Install terraform
 RUN \
     mkdir -p /tmp/docker-downloads \
     && curl -sSL -o /tmp/docker-downloads/terraform.zip https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_linux_${TARGETARCH}.zip \
@@ -34,7 +34,7 @@ RUN \
     go install -v golang.org/x/tools/cmd/goimports@latest \
     # # --> Gotestsum
     && go install -v gotest.tools/gotestsum@latest \
-    # # --> Go symbols and outline for go to symbol support and test support 
+    # # --> Go symbols and outline for go to symbol support and test support
     && go install github.com/acroca/[email protected] \
     # # --> Static checker
     && go install honnef.co/go/tools/cmd/[email protected] \

.devcontainer/devcontainer.json

@@ -31,7 +31,7 @@
 		// Use host network
 		"--network=host",
 	],
-	// Use 'settings' to set *default* container specific settings.json values on container create. 
+	// Use 'settings' to set *default* container specific settings.json values on container create.
 	// You can edit these settings after create using File > Preferences > Settings > Remote.
 	"settings": {
 		"terminal.integrated.shell.linux": "/bin/bash",
@@ -50,7 +50,7 @@
 			"completeUnimported": true, // autocomplete unimported packages
 			"deepCompletion": true, // enable deep completion
 		},
-		"files.eol": "\n", // formatting only supports LF line endings	
+		"files.eol": "\n", // formatting only supports LF line endings
 	},
 	// Uncomment the next line if you want to publish any ports.
 	// "appPort": [],

.dockerignore

@@ -4,4 +4,4 @@ dist
 examples
 scripts/*-integration/.terraform
 scripts/*-integration/*.log
-scripts/*-integration/*.out
+scripts/*-integration/*.out

.env.template

@@ -6,4 +6,4 @@ ARM_TENANT_ID=<active directory tenant id>
 ARM_SUBSCRIPTION_ID=<subscription id in which the workspace is being built>
 TEST_MANAGED_RESOURCE_GROUP=<managed resource group id for integration testing>
 TEST_WORKSPACE_NAME=<workspace name for integration testing>
-TEST_RESOURCE_GROUP=<workspace resource group for integration testing>
+TEST_RESOURCE_GROUP=<workspace resource group for integration testing>

.github/ISSUE_TEMPLATE/config.yml

@@ -7,8 +7,7 @@ contact_links:
   - name: General Terraform questions
     url: https://www.terraform.io/community
     about: Issues related to Terraform and not related to Databricks Terraform Provider.
-    
+
   - name: General questions on Databricks Terraform provider
     url: https://stackoverflow.com/questions/tagged/terraform-provider-databricks
     about: Please create a new question on StackOverflow with tag `terraform-provider-databricks`.
-    

.github/ISSUE_TEMPLATE/provider-issue.md

@@ -7,11 +7,11 @@ title: "[ISSUE] Issue with `databricks_XXX` resource"
 <!--
 Hi there,
 
-Please make sure that you checked Troubleshooting Guide first: 
+Please make sure that you checked Troubleshooting Guide first:
 https://registry.terraform.io/providers/databricks/databricks/latest/docs/guides/troubleshooting
 
-Thank you for opening an issue. 
-Please note that we try to keep the Databricks Provider issue tracker reserved for bug reports and feature requests. 
+Thank you for opening an issue.
+Please note that we try to keep the Databricks Provider issue tracker reserved for bug reports and feature requests.
 For general Terraform usage questions, please see: <https://www.terraform.io/community.html>.
 Questions about Databricks Provider please post on https://community.databricks.com
 -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,8 +2,8 @@
 <!-- Summary of your changes that are easy to understand -->
 
 ## Tests
-<!-- 
-How is this tested? Please see the checklist below and also describe any other relevant tests 
+<!--
+How is this tested? Please see the checklist below and also describe any other relevant tests
 -->
 
 - [ ] `make test` run locally

.github/workflows/next-changelog.yml

@@ -22,10 +22,10 @@ jobs:
         run: |
           # Use the GitHub API to fetch changed files
           files=$(gh pr view ${{ github.event.pull_request.number }} --json files -q '.files[].path')
-          
+
           # Sanitize to avoid code injection
           sanitized_files=$(echo "$files" | sed 's/[^a-zA-Z0-9._/-]/_/g')
-          
+
           # Store the sanitized list of files in a temporary file to avoid env variable issues
           echo "$sanitized_files" > modified_files.txt
 
@@ -36,10 +36,10 @@ jobs:
         run: |
           # Use the GitHub API to fetch the PR message
           pr_message=$(gh pr view ${{ github.event.pull_request.number }} --json body -q '.body')
-          
+
           # Sanitize the PR message to avoid code injection, keeping the equal sign
           sanitized_pr_message=$(echo "$pr_message" | sed 's/[^a-zA-Z0-9._/-=]/_/g')
-          
+
           # Store the sanitized PR message
           echo "$sanitized_pr_message" > pr_message.txt
 
@@ -48,12 +48,12 @@ jobs:
           # Read the sanitized files and PR message from the temporary files
           modified_files=$(cat modified_files.txt)
           pr_message=$(cat pr_message.txt)
-          
+
           # Check if NEXT_CHANGELOG.md exists in the list of changed files
           echo "Changed files: $modified_files"
           if ! echo "$modified_files" | grep -q "NEXT_CHANGELOG.md"; then
             echo "NEXT_CHANGELOG.md not modified."
-          
+
             # Check if PR message contains NO_CHANGELOG=true
             if echo "$pr_message" | grep -q "NO_CHANGELOG=true"; then
               echo "NO_CHANGELOG=true found in PR message. Skipping changelog check."
@@ -79,7 +79,7 @@ jobs:
             echo "Adding instructions comment."
             gh pr comment ${{ github.event.pull_request.number }} --body \
             "<!-- NEXT_CHANGELOG_INSTRUCTIONS -->
-            Please ensure that the NEXT_CHANGELOG.md file is updated with any relevant changes. 
+            Please ensure that the NEXT_CHANGELOG.md file is updated with any relevant changes.
             If this is not necessary for your PR, please include the following in your PR description:
             NO_CHANGELOG=true
             and rerun the job."
@@ -93,7 +93,7 @@ jobs:
           # Check if there is a previous instructions comment
           previous_comment_ids=$(gh api "repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments" \
             --jq '.[] | select(.body | startswith("<!-- NEXT_CHANGELOG_INSTRUCTIONS -->")) | .id')
-          
+
             # If a comment exists, delete it
             if [ -n "$previous_comment_ids" ]; then
               echo "Deleting previous instructions comment."

.github/workflows/push.yml

@@ -50,6 +50,9 @@ jobs:
           # -w: write back formatted files to disk
           gofmt -l -w ./
 
+      - name: Run whitespace validation
+        run: make ws
+
       - name: Fail on differences
         run: |
           # Exit with status code 1 if there are differences (i.e. unformatted files)