Rate limit (#2345)

* docs: Correct name of docs file

* tests: failed on main branch

When running the tests prior to making changes 2 issues were seen

1) With a setting to enable vulnerability alerts the tests failed,
adding them to be on in these tests doesn't impact the results and
allows others in the same position to run the tests.

2) The overwrte tests did not set attributes that were being asserted,
adding the attribures allow the test to pass. Not sure how these
previously passed.

* fix: Files should not be removed on rate limiting

---------

Co-authored-by: Keegan Campbell <[email protected]>

Author: grahamhar

github/resource_github_repository_file.go

@@ -2,7 +2,9 @@ package github
 
 import (
 	"context"
+	"errors"
 	"log"
+	"net/http"
 	"net/url"
 	"strings"
 
@@ -298,7 +300,13 @@ func resourceGithubRepositoryFileRead(d *schema.ResourceData, meta interface{})
 		opts.Ref = branch.(string)
 	}
 
-	fc, _, _, _ := client.Repositories.GetContents(ctx, owner, repo, file, opts)
+	fc, _, _, err := client.Repositories.GetContents(ctx, owner, repo, file, opts)
+	if err != nil {
+		var errorResponse *github.ErrorResponse
+		if errors.As(err, &errorResponse) && errorResponse.Response.StatusCode == http.StatusTooManyRequests {
+			return err
+		}
+	}
 	if fc == nil {
 		log.Printf("[INFO] Removing repository path %s/%s/%s from state because it no longer exists in GitHub",
 			owner, repo, file)

github/resource_github_repository_file_test.go

@@ -19,8 +19,9 @@ func TestAccGithubRepositoryFile(t *testing.T) {
 		config := fmt.Sprintf(`
 
 			resource "github_repository" "test" {
-				name      = "tf-acc-test-%s"
-				auto_init = true
+				name                 = "tf-acc-test-%s"
+				auto_init            = true
+				vulnerability_alerts = true
 			}
 
 			resource "github_repository_file" "test" {
@@ -92,8 +93,9 @@ func TestAccGithubRepositoryFile(t *testing.T) {
 
 		config := fmt.Sprintf(`
 			resource "github_repository" "test" {
-			  name      = "tf-acc-test-%s"
-			  auto_init = true
+			  name                 = "tf-acc-test-%s"
+			  auto_init            = true
+              vulnerability_alerts = true
 			}
 
 			resource "github_repository_file" "test" {
@@ -102,6 +104,9 @@ func TestAccGithubRepositoryFile(t *testing.T) {
 				file                = "README.md"
 				content             = "overwritten"
 				overwrite_on_create = false
+				commit_message      = "Managed by Terraform"
+				commit_author       = "Terraform User"
+				commit_email        = "[email protected]"
 			}
 
 		`, randomID)
@@ -167,8 +172,9 @@ func TestAccGithubRepositoryFile(t *testing.T) {
 		config := fmt.Sprintf(`
 
 			resource "github_repository" "test" {
-				name      = "tf-acc-test-%s"
-				auto_init = true
+				name                 = "tf-acc-test-%s"
+				auto_init            = true
+				vulnerability_alerts = true
 			}
 
 			resource "github_branch" "test" {
@@ -251,8 +257,9 @@ func TestAccGithubRepositoryFile(t *testing.T) {
 
 		config := fmt.Sprintf(`
 			resource "github_repository" "test" {
-				name      = "tf-acc-test-%s"
-				auto_init = true
+				name                 = "tf-acc-test-%s"
+				auto_init            = true
+				vulnerability_alerts = true
 			}
 
 			resource "github_repository_file" "test" {