[MAINT] Add tfproviderlint and fix it's reported issues

CONTRIBUTING.md

@@ -13,8 +13,9 @@ Before submitting an issue or a pull request, please search the repository for e
 1. Fork and clone the repository.
 2. Create a new branch: `git switch -c my-branch-name`.
 3. Make your change, add tests, and make sure the tests still pass.
-4. Push to your fork and submit a pull request.
-5. Pat yourself on the back and wait for your pull request to be reviewed and merged.
+4. Run `make fmt; make lint; make tf-provider-lint` to check for formatting, linting, and provider linting errors.
+5. Push to your fork and submit a pull request.
+6. Pat yourself on the back and wait for your pull request to be reviewed and merged.
 
 Here are a few things you can do that will increase the likelihood of your pull request being accepted:
 
@@ -33,9 +34,9 @@ This section describes a typical sequence performed when developing locally. Ful
 Once you have the repository cloned, there's a couple of additional steps you'll need to take. Since most of the testing is acceptance or integration testing, we need to manipulate real GitHub resources in order to run it. Useful setup steps are listed below:
 
 - If you haven't already, [create a GitHub organization you can use for testing](#github-organization).
-  - Optional: you may find it beneficial to create a test user as well in order to avoid potential rate-limiting issues on your main account.
-  - Your organization _must_ have a repository called `terraform-template-module`. The [terraformtesting/terraform-template-module](https://github.com/terraformtesting/terraform-template-module) repo is a good, re-usable example.
-    - You _must_ make sure that the "Template Repository" item in Settings is checked for this repo.
+    - Optional: you may find it beneficial to create a test user as well in order to avoid potential rate-limiting issues on your main account.
+    - Your organization _must_ have a repository called `terraform-template-module`. The [terraformtesting/terraform-template-module](https://github.com/terraformtesting/terraform-template-module) repo is a good, re-usable example.
+        - You _must_ make sure that the "Template Repository" item in Settings is checked for this repo.
 - If you haven't already, generate a Personal Access Token (PAT) for authenticating your test runs.
 - Export the necessary configuration for authenticating your provider with GitHub
 
@@ -52,7 +53,7 @@ Once you have the repository cloned, there's a couple of additional steps you'll
 ### Local Development Iteration
 
 1. Write a test describing what you will fix. See [`github_label`](./github/resource_github_issue_label_test.go) for an example format.
-1. Run your test and observe it fail. Enabling debug output allows for observing the underlying requests and responses made as well as viewing state (search `STATE:`) generated during the acceptance test run.
+2. Run your test and observe it fail. Enabling debug output allows for observing the underlying requests and responses made as well as viewing state (search `STATE:`) generated during the acceptance test run.
 
 ```sh
 TF_LOG=DEBUG TF_ACC=1 go test -v ./... -run ^TestAccGithubIssueLabel

GNUmakefile

@@ -30,6 +30,7 @@ default: build
 tools:
 	go install github.com/client9/misspell/cmd/misspell@v0.3.4
 	go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.6.0
+	go install github.com/bflad/tfproviderlint/cmd/tfproviderlintx@latest
 
 build: lintcheck
 	CGO_ENABLED=0 go build -ldflags="-s -w" ./...
@@ -46,6 +47,29 @@ lintcheck:
 	@echo "==> Checking source code against linters..."
 	golangci-lint run ./...
 
+tf-provider-lint:
+	@branch=$$(git rev-parse --abbrev-ref HEAD); \
+	printf "==> Running TF provider lint on branch: \033[1m%s\033[0m...\n" "🌿 $$branch 🌿";
+	# Disabled linter rules:
+	# AT001: TestCase missing CheckDestroy - not yet adopted across all tests
+	# AT003: should use underscores in acc test names - not yet adopted across all tests
+	# AT004: provider declaration should be omitted - intentionally kept for provider configuration tests
+	# AT006: acc tests should not contain multiple resource.Test() invocations - not yet adopted across all tests
+	# XAT001: acceptance test should use ErrorCheck - not all resources support destroy verification
+	# XR003: resource should configure Timeouts - not yet adopted across all resources
+	# XR007: avoid os/exec.Command - intentionally used for GitHub CLI integration and ssh-keygen in tests
+	# XS002: schema should use keys in alphabetical order - not sure we want to enforce this
+	tfproviderlintx \
+		-AT001=false \
+		-AT003=false \
+		-AT004=false \
+		-AT006=false \
+		-XAT001=false \
+		-XR003=false \
+		-XR007=false \
+		-XS002=false \
+		$(TEST)
+
 test:
 	@branch=$$(git rev-parse --abbrev-ref HEAD); \
 	printf "==> Running unit tests on branch: \033[1m%s\033[0m...\n" "🌿 $$branch 🌿"
@@ -84,4 +108,4 @@ ifeq (,$(wildcard $(GOPATH)/src/$(WEBSITE_REPO)))
 endif
 	@$(MAKE) -C $(GOPATH)/src/$(WEBSITE_REPO) website-provider-test PROVIDER_PATH=$(shell pwd) PROVIDER_NAME=$(PKG_NAME)
 
-.PHONY: build test testacc fmt lint lintcheck tools website website-lint website-test sweep
+.PHONY: build test testacc fmt lint lintcheck tools website website-lint website-test sweep tf-provider-lint

github/data_source_github_actions_environment_public_key.go

@@ -14,20 +14,24 @@ func dataSourceGithubActionsEnvironmentPublicKey() *schema.Resource {
 
 		Schema: map[string]*schema.Schema{
 			"repository": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The name of the repository.",
 			},
 			"environment": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The name of the environment.",
 			},
 			"key_id": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The identifier for the key.",
 			},
 			"key": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The Base64 encoded public key.",
 			},
 		},
 	}

github/data_source_github_actions_environment_public_key_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestAccGithubActionsEnvironmentPublicKeyDataSource(t *testing.T) {
 	t.Run("queries a repository environment public key without error", func(t *testing.T) {
-		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
+		randomID := acctest.RandString(5)
 		repoName := fmt.Sprintf("%srepo-env-pubkey-%s", testResourcePrefix, randomID)
 
 		config := fmt.Sprintf(`

github/data_source_github_actions_environment_secrets.go

@@ -20,33 +20,40 @@ func dataSourceGithubActionsEnvironmentSecrets() *schema.Resource {
 				Optional:      true,
 				Computed:      true,
 				ConflictsWith: []string{"name"},
+				Description:   "Full name of the repository (in org/name format).",
 			},
 			"name": {
 				Type:          schema.TypeString,
 				Optional:      true,
 				Computed:      true,
 				ConflictsWith: []string{"full_name"},
+				Description:   "The name of the repository.",
 			},
 			"environment": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The name of the environment.",
 			},
 			"secrets": {
-				Type:     schema.TypeList,
-				Computed: true,
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "List of secrets for the environment.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"name": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The name of the secret.",
 						},
 						"created_at": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Timestamp of the secret creation.",
 						},
 						"updated_at": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Timestamp of the secret last update.",
 						},
 					},
 				},

github/data_source_github_actions_environment_secrets_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestAccGithubActionsEnvironmentSecretsDataSource(t *testing.T) {
 	t.Run("queries actions secrets from an environment", func(t *testing.T) {
-		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
+		randomID := acctest.RandString(5)
 		repoName := fmt.Sprintf("%srepo-env-secrets-%s", testResourcePrefix, randomID)
 
 		config := fmt.Sprintf(`

github/data_source_github_actions_environment_variables.go

@@ -20,37 +20,45 @@ func dataSourceGithubActionsEnvironmentVariables() *schema.Resource {
 				Optional:      true,
 				Computed:      true,
 				ConflictsWith: []string{"name"},
+				Description:   "Full name of the repository (in org/name format).",
 			},
 			"name": {
 				Type:          schema.TypeString,
 				Optional:      true,
 				Computed:      true,
 				ConflictsWith: []string{"full_name"},
+				Description:   "The name of the repository.",
 			},
 			"environment": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The name of the environment.",
 			},
 			"variables": {
-				Type:     schema.TypeList,
-				Computed: true,
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "List of variables for the environment.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"name": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The name of the variable.",
 						},
 						"value": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The value of the variable.",
 						},
 						"created_at": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Timestamp of the variable creation.",
 						},
 						"updated_at": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Timestamp of the variable last update.",
 						},
 					},
 				},

github/data_source_github_actions_environment_variables_test.go

@@ -11,7 +11,7 @@ import (
 
 func TestAccGithubActionsEnvironmentVariablesDataSource(t *testing.T) {
 	t.Run("queries actions variables from an environment", func(t *testing.T) {
-		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
+		randomID := acctest.RandString(5)
 		repoName := fmt.Sprintf("%srepo-env-vars-%s", testResourcePrefix, randomID)
 
 		config := fmt.Sprintf(`

github/data_source_github_actions_organization_oidc_subject_claim_customization_template.go

@@ -6,12 +6,14 @@ import (
 
 func dataSourceGithubActionsOrganizationOIDCSubjectClaimCustomizationTemplate() *schema.Resource {
 	return &schema.Resource{
-		Read: dataSourceGithubActionsOrganizationOIDCSubjectClaimCustomizationTemplateRead,
+		Description: "Use this data source to retrieve the OpenID Connect subject claim customization template for an organization.",
+		Read:        dataSourceGithubActionsOrganizationOIDCSubjectClaimCustomizationTemplateRead,
 
 		Schema: map[string]*schema.Schema{
 			"include_claim_keys": {
-				Type:     schema.TypeList,
-				Computed: true,
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "A list of OpenID Connect claim keys.",
 				Elem: &schema.Schema{
 					Type: schema.TypeString,
 				},

github/data_source_github_actions_organization_public_key.go

@@ -8,16 +8,19 @@ import (
 
 func dataSourceGithubActionsOrganizationPublicKey() *schema.Resource {
 	return &schema.Resource{
-		Read: dataSourceGithubActionsOrganizationPublicKeyRead,
+		Description: "Use this data source to retrieve the public key for an organization's GitHub Actions secrets.",
+		Read:        dataSourceGithubActionsOrganizationPublicKeyRead,
 
 		Schema: map[string]*schema.Schema{
 			"key_id": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The identifier for the key.",
 			},
 			"key": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The Base64 encoded public key.",
 			},
 		},
 	}

github/data_source_github_actions_organization_registration_token.go

@@ -10,16 +10,19 @@ import (
 
 func dataSourceGithubActionsOrganizationRegistrationToken() *schema.Resource {
 	return &schema.Resource{
-		Read: dataSourceGithubActionsOrganizationRegistrationTokenRead,
+		Description: "Use this data source to retrieve a registration token for a GitHub Actions self-hosted runner in an organization.",
+		Read:        dataSourceGithubActionsOrganizationRegistrationTokenRead,
 
 		Schema: map[string]*schema.Schema{
 			"token": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The token that has been retrieved.",
 			},
 			"expires_at": {
-				Type:     schema.TypeInt,
-				Computed: true,
+				Type:        schema.TypeInt,
+				Computed:    true,
+				Description: "The token expiration date as a Unix timestamp.",
 			},
 		},
 	}

github/data_source_github_actions_organization_secrets.go

@@ -10,29 +10,35 @@ import (
 
 func dataSourceGithubActionsOrganizationSecrets() *schema.Resource {
 	return &schema.Resource{
-		Read: dataSourceGithubActionsOrganizationSecretsRead,
+		Description: "Use this data source to retrieve the list of secrets for a GitHub organization.",
+		Read:        dataSourceGithubActionsOrganizationSecretsRead,
 
 		Schema: map[string]*schema.Schema{
 			"secrets": {
-				Type:     schema.TypeList,
-				Computed: true,
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "List of secrets for the organization.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"name": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The name of the secret.",
 						},
 						"visibility": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The visibility of the secret (all, private, or selected).",
 						},
 						"created_at": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Timestamp of the secret creation.",
 						},
 						"updated_at": {
-							Type:     schema.TypeString,
-							Computed: true,
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Timestamp of the secret last update.",
 						},
 					},
 				},

github/data_source_github_actions_organization_secrets_test.go

@@ -11,7 +11,7 @@ import (
 
 func TestAccGithubActionsOrganizationSecretsDataSource(t *testing.T) {
 	t.Run("queries organization actions secrets from a repository", func(t *testing.T) {
-		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
+		randomID := acctest.RandString(5)
 
 		config := fmt.Sprintf(`
 			resource "github_actions_organization_secret" "test" {