docs: Adds test to verify that unarchiving does work and update docs

Signed-off-by: Timo Sand <[email protected]>

Author: deiga

github/resource_github_repository.go

@@ -322,7 +322,7 @@ func resourceGithubRepository() *schema.Resource {
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Default:     false,
-				Description: "Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving.",
+				Description: "Specifies if the repository should be archived. Defaults to 'false'. Unarchiving is supported by setting this back to 'false'.",
 			},
 			"archive_on_destroy": {
 				Type:        schema.TypeBool,
@@ -934,7 +934,7 @@ func resourceGithubRepositoryRead(ctx context.Context, d *schema.ResourceData, m
 
 func resourceGithubRepositoryUpdate(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
 	// Can only update a repository if it is not archived or the update is to
-	// archive the repository (unarchiving is not supported by the GitHub API)
+	// archive the repository
 	if d.Get("archived").(bool) && !d.HasChange("archived") {
 		log.Printf("[INFO] Skipping update of archived repository")
 		return nil

github/resource_github_repository_test.go

@@ -209,6 +209,55 @@ func TestAccGithubRepository(t *testing.T) {
 			},
 		})
 	})
+	t.Run("unarchives archived repositories without error", func(t *testing.T) {
+		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
+		testRepoName := fmt.Sprintf("%sunarchive-%s", testResourcePrefix, randomID)
+		config := fmt.Sprintf(`
+			resource "github_repository" "test" {
+				name         = "%s"
+				description  = "Terraform acceptance tests %[1]s"
+				archived     = false
+				visibility   = "%s"
+			}
+		`, testRepoName, baseVisibility)
+
+		resource.Test(t, resource.TestCase{
+			PreCheck:          func() { skipUnauthenticated(t) },
+			ProviderFactories: providerFactories,
+			Steps: []resource.TestStep{
+				{
+					Config: config,
+					Check: resource.ComposeTestCheckFunc(
+						resource.TestCheckResourceAttr(
+							"github_repository.test", "archived",
+							"false",
+						),
+					),
+				},
+				{
+					Config: strings.Replace(config,
+						`archived     = false`,
+						`archived     = true`, 1),
+					Check: resource.ComposeTestCheckFunc(
+						resource.TestCheckResourceAttr(
+							"github_repository.test", "archived",
+							"true",
+						),
+					),
+				},
+				{
+					Config: config,
+					Check: resource.ComposeTestCheckFunc(
+						resource.TestCheckResourceAttr(
+							"github_repository.test", "archived",
+							"false",
+						),
+					),
+				},
+			},
+		})
+	})
+
 	t.Run("creates_repositories_as_archived_without_error", func(t *testing.T) {
 		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
 		testRepoName := fmt.Sprintf("%screate-and-archive-%s", testResourcePrefix, randomID)
@@ -246,8 +295,9 @@ func TestAccGithubRepository(t *testing.T) {
 				name         = "%s"
 				description  = "Terraform acceptance tests %[1]s"
 				has_projects = false
+				visibility   = "%s"
 			}
-		`, testRepoName)
+		`, testRepoName, baseVisibility)
 
 		checks := map[string]resource.TestCheckFunc{
 			"before": resource.ComposeTestCheckFunc(
@@ -524,8 +574,9 @@ func TestAccGithubRepository(t *testing.T) {
 				auto_init          = true
 				archive_on_destroy = true
 				archived           = false
+				visibility         = "%s"
 			}
-		`, testRepoName)
+		`, testRepoName, baseVisibility)
 
 		checks := map[string]resource.TestCheckFunc{
 			"before": resource.ComposeTestCheckFunc(