Update docs to use generated content

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Author: deiga

RESOURCES.md

@@ -179,7 +179,7 @@ The overall status of each resource or data source is captured in this document
 | `github_project_card` (🚫) | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ |
 | `github_project_column` (🚫) | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ |
 | `github_release` | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ |
-| `github_repository` | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ |
+| `github_repository` | ⚠️ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
 | `github_repository_autolink_reference` | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ |
 | `github_repository_collaborator` | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ |
 | `github_repository_collaborators` | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ | ❓ |

docs/resources/repository.md

@@ -0,0 +1 @@
+terraform import github_repository.terraform myrepo

examples/resources/github_repository/import.sh

@@ -35,6 +35,8 @@ func resourceGithubRepository() *schema.Resource {
 			},
 		},
 
+		Description: "This resource allows you to create and manage repositories within your GitHub organization or personal account.",
+
 		Schema: map[string]*schema.Schema{
 			"name": {
 				Type:             schema.TypeString,
@@ -58,6 +60,7 @@ func resourceGithubRepository() *schema.Resource {
 				Optional:      true,
 				ConflictsWith: []string{"visibility"},
 				Deprecated:    "use visibility instead",
+				Description:   "Set to `true` to create a private repository. Repositories are created as public (e.g. open source) by default. Use `visibility` instead.",
 			},
 			"visibility": {
 				Type:             schema.TypeString,
@@ -405,10 +408,11 @@ func resourceGithubRepository() *schema.Resource {
 				Deprecated:  "Use the github_repository_vulnerability_alerts resource instead. This field will be removed in a future version.",
 			},
 			"ignore_vulnerability_alerts_during_read": {
-				Type:       schema.TypeBool,
-				Optional:   true,
-				Default:    false,
-				Deprecated: "This is ignored as the provider now handles lack of permissions automatically. This field will be removed in a future version.",
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+				Deprecated:  "This is ignored as the provider now handles lack of permissions automatically. This field will be removed in a future version.",
+				Description: "This is ignored as the provider now handles lack of permissions automatically. This field will be removed in a future version.",
 			},
 			"full_name": {
 				Type:        schema.TypeString,
@@ -448,16 +452,18 @@ func resourceGithubRepository() *schema.Resource {
 					return true
 				},
 				DiffSuppressOnRefresh: true,
+				Description:           "An etag representing the repository object.",
 			},
 			"primary_language": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The primary language of the repository. This is the language with the largest number of bytes of code, as determined by GitHub's linguist library.",
 			},
 			"template": {
 				Type:        schema.TypeList,
 				Optional:    true,
 				MaxItems:    1,
-				Description: "Use a template repository to create this resource.",
+				Description: "Use a template repository to create this resource.\n\n\t~> **Note on `internal` visibility with templates**: When creating a repository from a template with `visibility = \"internal\"`, the provider uses a two-step process due to GitHub API limitations. The template creation API only supports a `private` boolean parameter. Therefore, repositories with `visibility = \"internal\"` are initially created as private and then immediately updated to internal visibility. This ensures internal repositories are never exposed publicly during creation.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"include_all_branches": {

…amples/resources/repository/example_1.tf …rces/github_repository/resource_basic.tfexamples/resources/repository/example_1.tf renamed to examples/resources/github_repository/resource_basic.tf examples/resources/repository/example_1.tf renamed to examples/resources/github_repository/resource_basic.tf

@@ -1,209 +1,56 @@
 ---
 page_title: "{{.Name}} ({{.Type}}) - {{.RenderedProviderName}}"
+subcategory: ""
 description: |-
-  Creates and manages repositories within GitHub organizations or personal accounts
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
 ---
 
 # {{.Name}} ({{.Type}})
 
-This resource allows you to create and manage repositories within your GitHub organization or personal account.
+{{ .Description | trimspace }}
 
 ~> **Note** When used with GitHub App authentication, even GET requests must have the `contents:write` permission. Without it, the following arguments will be ignored, leading to unexpected behavior and confusing diffs: `allow_merge_commit`, `allow_squash_merge`, `allow_rebase_merge`, `merge_commit_title`, `merge_commit_message`, `squash_merge_commit_title` and `squash_merge_commit_message`.
 
+{{ if .HasExamples -}}
 ## Example Usage
 
-{{ tffile "examples/resources/repository/example_1.tf" }}
+{{- range .ExampleFiles }}
 
-## Example Usage with Repository Forking
+{{- $parts := split . "resource_" -}}
+{{- $lastItem := index $parts 1 }}
+{{- $fileNameParts := split $lastItem "." }}
+{{- $fileName := index $fileNameParts 0 }}
 
-{{ tffile "examples/resources/repository/example_2.tf" }}
+### {{ $fileName | title }}
 
-## Argument Reference
+{{ tffile . }}
+{{- end }}
+{{- end }}
 
-The following arguments are supported:
+{{ .SchemaMarkdown | trimspace }}
+{{- if or .HasImport .HasImportIDConfig .HasImportIdentityConfig }}
 
-- `name` - (Required) The name of the repository.
-
-- `description` - (Optional) A description of the repository.
-
-- `homepage_url` - (Optional) URL of a page describing the project.
-
-- `fork` - (Optional) Set to `true` to create a fork of an existing repository. When set to `true`, both `source_owner` and `source_repo` must also be specified.
-
-- `source_owner` - (Optional) The GitHub username or organization that owns the repository being forked. Required when `fork` is `true`.
-
-- `source_repo` - (Optional) The name of the repository to fork. Required when `fork` is `true`.
-
-- `private` - (**DEPRECATED**) (Optional) Set to `true` to create a private repository. Repositories are created as public (e.g. open source) by default. Use `visibility` instead.
-
-- `visibility` - (Optional) Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be `internal`. The `visibility` parameter overrides the `private` parameter.
-
-- `has_issues` - (Optional) Set to `true` to enable the GitHub Issues features on the repository.
-
-- `has_discussions` - (Optional) Set to `true` to enable GitHub Discussions on the repository. Defaults to `false`.
-
-- `has_projects` - (Optional) Set to `true` to enable the GitHub Projects features on the repository. Per the GitHub [documentation](https://developer.github.com/v3/repos/#create) when in an organization that has disabled repository projects it will default to `false` and will otherwise default to `true`. If you specify `true` when it has been disabled it will return an error.
-
-- `has_wiki` - (Optional) Set to `true` to enable the GitHub Wiki features on the repository.
-
-- `is_template` - (Optional) Set to `true` to tell GitHub that this is a template repository.
-
-- `allow_merge_commit` - (Optional) Set to `false` to disable merge commits on the repository.
-
-- `allow_squash_merge` - (Optional) Set to `false` to disable squash merges on the repository.
-
-- `allow_rebase_merge` - (Optional) Set to `false` to disable rebase merges on the repository.
-
-- `allow_auto_merge` - (Optional) Set to `true` to allow auto-merging pull requests on the repository.
-
-- `allow_forking` - (Optional) Configure private forking for organization owned private and internal repositories; set to `true` to enable, `false` to disable, and leave unset for the default behaviour. Configuring this requires that private forking is not being explicitly configured at the organization level.
-
-- `squash_merge_commit_title` - (Optional) Can be `PR_TITLE` or `COMMIT_OR_PR_TITLE` for a default squash merge commit title. Applicable only if `allow_squash_merge` is `true`.
-
-- `squash_merge_commit_message` - (Optional) Can be `PR_BODY`, `COMMIT_MESSAGES`, or `BLANK` for a default squash merge commit message. Applicable only if `allow_squash_merge` is `true`.
-
-- `merge_commit_title` - (Optional) Can be `PR_TITLE` or `MERGE_MESSAGE` for a default merge commit title. Applicable only if `allow_merge_commit` is `true`.
-
-- `merge_commit_message` - (Optional) Can be `PR_BODY`, `PR_TITLE`, or `BLANK` for a default merge commit message. Applicable only if `allow_merge_commit` is `true`.
-
-- `delete_branch_on_merge` - (Optional) Automatically delete head branch after a pull request is merged. Defaults to `false`.
-
-- `web_commit_signoff_required` - (Optional) Require contributors to sign off on web-based commits. See more in the [GitHub documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository).
-
-- `has_downloads` - (**DEPRECATED**) (Optional) Set to `true` to enable the (deprecated) downloads features on the repository. This attribute is no longer in use, but it hasn't been removed yet. It will be removed in a future version. See [this discussion](https://github.com/orgs/community/discussions/102145#discussioncomment-8351756).
-
-- `auto_init` - (Optional) Set to `true` to produce an initial commit in the repository.
-
-- `gitignore_template` - (Optional) Use the [name of the template](https://github.com/github/gitignore) without the extension. For example, "Haskell".
-
-- `license_template` - (Optional) Use the [name of the template](https://github.com/github/choosealicense.com/tree/gh-pages/_licenses) without the extension. For example, "mit" or "mpl-2.0".
-
-- `default_branch` - (Optional) (Deprecated: Use `github_branch_default` resource instead) The name of the default branch of the repository. **NOTE:** This can only be set after a repository has already been created, and after a correct reference has been created for the target branch inside the repository. This means a user will have to omit this parameter from the initial repository creation and create the target branch inside of the repository prior to setting this attribute.
-
-- `archived` - (Optional) Specifies if the repository should be archived. Defaults to `false`. **NOTE** Currently, the API does not support unarchiving.
-
-- `archive_on_destroy` - (Optional) Set to `true` to archive the repository instead of deleting on destroy.
-
-- `pages` - (Optional) (**DEPRECATED**) The repository's GitHub Pages configuration. Use the `github_repository_pages` resource instead. This field will be removed in a future version. See [GitHub Pages Configuration](#github-pages-configuration) below for details.
-
-- `security_and_analysis` - (Optional) The repository's [security and analysis](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository) configuration. See [Security and Analysis Configuration](#security-and-analysis-configuration) below for details.
-
-- `topics` - (Optional) The list of topics of the repository.
-
-~> Note: This attribute is not compatible with the `github_repository_topics` resource. Use one of them. `github_repository_topics` is only meant to be used if the repository itself is not handled via terraform, for example if it's only read as a datasource (see [issue #1845](https://github.com/integrations/terraform-provider-github/issues/1845)).
-
-- `template` - (Optional) Use a template repository to create this resource. See [Template Repositories](#template-repositories) below for details.
-
-- `vulnerability_alerts` - (Optional) (**DEPRECATED**) Configure [Dependabot security alerts](https://help.github.com/en/github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies) for vulnerable dependencies; set to `true` to enable, set to `false` to disable, and leave unset for the default behavior. Configuring this requires that alerts are not being explicitly configured at the organization level. This field will be removed in a future version. Use the `github_repository_vulnerability_alerts` resource instead.
-
-- `ignore_vulnerability_alerts_during_read` (**DEPRECATED**) (Optional) - This is ignored as the provider now handles lack of permissions automatically. This field will be removed in a future version.
-
-- `allow_update_branch` (Optional) - Set to `true` to always suggest updating pull request branches.
-
-### GitHub Pages Configuration
-
-The `pages` block supports the following:
-
-- `source` - (Optional) The source branch and directory for the rendered Pages site. See [GitHub Pages Source](#github-pages-source) below for details.
-
-- `build_type` - (Optional) The type of GitHub Pages site to build. Can be `legacy` or `workflow`. If you use `legacy` as build type you need to set the option `source`.
-
-- `cname` - (Optional) The custom domain for the repository. This can only be set after the repository has been created.
-
-#### GitHub Pages Source
-
-The `source` block supports the following:
-
-- `branch` - (Required) The repository branch used to publish the site's source files. (i.e. `main` or `gh-pages`.
-
-- `path` - (Optional) The repository directory from which the site publishes (Default: `/`).
-
-### Security and Analysis Configuration
-
-The `security_and_analysis` block supports the following:
-
-- `advanced_security` - (Optional) The advanced security configuration for the repository. See [Advanced Security Configuration](#advanced-security-configuration) below for details. If a repository's visibility is `public`, advanced security is always enabled and cannot be changed, so this setting cannot be supplied.
-
-- `code_security` - (Optional) The code security configuration for the repository. See [Code Security](#code-security-configuration) below for details.
-
-- `secret_scanning` - (Optional) The secret scanning configuration for the repository. See [Secret Scanning Configuration](#secret-scanning-configuration) below for details.
-
-- `secret_scanning_push_protection` - (Optional) The secret scanning push protection configuration for the repository. See [Secret Scanning Push Protection Configuration](#secret-scanning-push-protection-configuration) below for details.
-
-- `secret_scanning_ai_detection` - (Optional) The secret scanning ai detection configuration for the repository. See [Secret Scanning AI Detection Configuration](#secret-scanning-ai-detection) below for details.
-
-- `secret_scanning_non_provider_patterns` - (Optional) The secret scanning non-provider patterns configuration for this repository. See [Secret Scanning Non-Provider Patterns Configuration](#secret-scanning-non-provider-patterns) below for more details.
-
-#### Advanced Security Configuration
-
-The `advanced_security` block supports the following:
-
-- `status` - (Required) Set to `enabled` to enable advanced security features on the repository. Can be `enabled` or `disabled`.
-
-#### Code Security Configuration
-
-- `status` - (Required) Set to `enabled` to enable GitHub Code Security on the repository. Can be `enabled` or `disabled`. If set to `enabled`, the repository's visibility must be `public`, `security_and_analysis[0].advanced_security[0].status` must also be set to `enabled`, or your Organization must have split licensing for Advanced security.
-
-#### Secret Scanning Configuration
-
-- `status` - (Required) Set to `enabled` to enable secret scanning on the repository. Can be `enabled` or `disabled`. If set to `enabled`, the repository's visibility must be `public`, `security_and_analysis[0].advanced_security[0].status` must also be set to `enabled`, or your Organization must have split licensing for Advanced security.
-
-#### Secret Scanning Push Protection Configuration
-
-- `status` - (Required) Set to `enabled` to enable secret scanning push protection on the repository. Can be `enabled` or `disabled`. If set to `enabled`, the repository's visibility must be `public`, `security_and_analysis[0].advanced_security[0].status` must also be set to `enabled`, or your Organization must have split licensing for Advanced security.
-
-#### Secret Scanning AI Detection
-
-- `status` - (Required) Set to `enabled` to enable secret scanning AI detection on the repository. Can be `enabled` or `disabled`. If set to `enabled`, the repository's visibility must be `public`, `security_and_analysis[0].advanced_security[0].status` must also be set to `enabled`, or your Organization must have split licensing for Advanced security.
-
-#### Secret Scanning Non-Provider Patterns
-
-- `status` - (Required) Set to `enabled` to enable secret scanning non-provider patterns on the repository. Can be `enabled` or `disabled`. If set to `enabled`, the repository's visibility must be `public`, `security_and_analysis[0].advanced_security[0].status` must also be set to `enabled`, or your Organization must have split licensing for Advanced security.
-
-### Template Repositories
-
-`template` supports the following arguments:
-
-- `owner`: The GitHub organization or user the template repository is owned by.
-- `repository`: The name of the template repository.
-- `include_all_branches`: Whether the new repository should include all the branches from the template repository (defaults to false, which includes only the default branch from the template).
-
-~> **Note on `internal` visibility with templates**: When creating a repository from a template with `visibility = "internal"`, the provider uses a two-step process due to GitHub API limitations. The template creation API only supports a `private` boolean parameter. Therefore, repositories with `visibility = "internal"` are initially created as private and then immediately updated to internal visibility. This ensures internal repositories are never exposed publicly during creation.
-
-## Attributes Reference
-
-The following additional attributes are exported:
-
-- `full_name` - A string of the form "repo_owner/reponame".
-
-- `html_url` - URL to the repository on the web.
-
-- `ssh_clone_url` - URL that can be provided to `git clone` to clone the repository via SSH.
-
-- `http_clone_url` - URL that can be provided to `git clone` to clone the repository via HTTPS.
-
-- `git_clone_url` - URL that can be provided to `git clone` to clone the repository anonymously via the git protocol.
-
-- `svn_url` - URL that can be provided to `svn checkout` to check out the repository via GitHub's Subversion protocol emulation.
+## Import
 
-- `node_id` - GraphQL global node id for use with v4 API
+Import is supported using the following syntax:
+{{- end }}
+{{- if .HasImportIdentityConfig }}
 
-- `repo_id` - GitHub ID for the repository
+In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute, for example:
 
-- `primary_language` - The primary language used in the repository.
+{{tffile .ImportIdentityConfigFile }}
 
-- `etag` - An etag representing the repository object.
+{{ .IdentitySchemaMarkdown | trimspace }}
+{{- end }}
+{{- if .HasImportIDConfig }}
 
-- `pages` - The block consisting of the repository's GitHub Pages configuration.
-  - `custom_404` - Whether the rendered GitHub Pages site has a custom 404 page.
-  - `html_url` - The absolute URL (including scheme) of the rendered GitHub Pages site e.g. `https://username.github.io`.
-  - `status` - The Pages build status of the latest build e.g. `building`, `built` `errored`.
-  - `url` - The API address for accessing this Page resource.
+In Terraform v1.5.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `id` attribute, for example:
 
-## Import
+{{tffile .ImportIDConfigFile }}
+{{- end }}
+{{- if .HasImport }}
 
-Repositories can be imported using the `name`, e.g.
+The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
 
-```shell
-terraform import github_repository.terraform myrepo
-```
+{{codefile "shell" .ImportFile }}
+{{- end }}