chore: Use tf plugin docs by stevehipwell · Pull Request #3380 · integrations/terraform-provider-github

stevehipwell · 2026-04-29T14:52:45Z

Resolves #2924
Resolves #2961
Resolves #2897
Resolves #3241
Closes #2987
Closes #3199

Before the change?

Docs were manually written using the legacy website pattern

After the change?

Docs auto-generated using tfplugindocs
- Not really
- They're using (mostly) static templates
- We need to migrate each doc to either use either the generic template or to use dynamic sections in their templates

Pull request checklist

Schema migrations have been created if needed (example)
Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

Yes
No

github-actions · 2026-04-29T14:52:56Z

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

Signed-off-by: Steve Hipwell <[email protected]>

deiga

Great work!

deiga · 2026-04-29T17:52:10Z

+  workflow_dispatch: # push:
+


Should this just be removed?

Suggested change

workflow_dispatch: # push:

workflow_dispatch:

deiga · 2026-04-29T17:55:51Z

+          GITHUB_OWNER: ${{ (matrix.mode == 'individual' && vars.GH_TEST_LOGIN) ||
+            (matrix.mode == 'organization' && vars.GH_TEST_ORG_NAME) || '' }}


This can be made slightly easier to read with case() https://docs.github.com/en/actions/reference/workflows-and-actions/expressions?versionId=free-pro-team@latest&productId=actions#case

Suggested change

GITHUB_OWNER: ${{ (matrix.mode == 'individual' && vars.GH_TEST_LOGIN) ||

(matrix.mode == 'organization' && vars.GH_TEST_ORG_NAME) || '' }}

GITHUB_OWNER: ${{ case(matrix.mode == 'individual', vars.GH_TEST_LOGIN, matrix.mode == 'organization', vars.GH_TEST_ORG_NAME, '') }}

deiga · 2026-04-29T18:25:06Z

+          subject-checksums: ./dist/${{ github.event.repository.name }}_${{
+            fromJSON(steps.goreleaser.outputs.metadata).version }}_SHA256SUMS


question: Will this line break work?

deiga · 2026-04-29T18:27:53Z

+  Get Actions secrets of the repository environment
+---
+
+# github\_actions\_environment\_secrets


question: are these \_ escapes relevant? I think they are unnecessary, since not every page has those

deiga · 2026-04-29T19:37:41Z

+}
+```
+
+## Argument Reference


issue: I see that this is a copy of the existing docs, but would it make sense to us something like .SchemaMarkdown in the template here, to get the missing arguments?

deiga · 2026-04-30T06:47:28Z

+disable = ["MD013", "MD028"]
+
+[per-file-ignores]
+".github/pull_request_template.md" = ["MD041"]


suggestion: I would Ignore MD009 as well in the PR template as the empty lines are meaningful in there

Suggested change

".github/pull_request_template.md" = ["MD041"]

".github/pull_request_template.md" = ["MD041", "MD009"]

deiga · 2026-05-01T19:02:19Z

-## Example Usage Security Manager Role
-
-```terraform
-locals {
-  security_manager_id = one([for x in data.github_organization_roles.all_roles.roles : x.role_id if x.name == "security_manager"])
-}
-
-data "github_organization_roles" "all_roles" {}
-
-resource "github_organization_role_team" "security_managers" {
-  role_id   = local.security_manager_id
-  team_slug = "example-team"
-}
-```
-


question: Was this removed on purpose?

deiga · 2026-05-01T19:06:53Z

-  fork         = true
-  source_owner = "some-org"
-  source_repo  = "original-repository"
+```terraform


issue: This seems to have been mixed up. The pages example was removed as it's deprecated

deiga · 2026-05-01T19:10:24Z

 GitHub Repository Custom Property can be imported using an ID made up of a combination of the names of the organization, repository, custom property separated by a `:` character, e.g.

-```
+```hcl


AFAIK these are shell and not hcl. This seems to be misaligned in multiple pages

Suggested change

```hcl

```shell

deiga · 2026-05-01T19:22:57Z

 ```

- You **must** add a `required_providers` block to every module that will create resources with this provider. If you do not explicitly require `integrations/github` in a submodule, your terraform run may [break in hard-to-troubleshoot ways](https://github.com/integrations/terraform-provider-github/issues/876#issuecomment-1303790559).
+- You **must*- add a `required_providers` block to every module that will create resources with this provider. If you do not explicitly require `integrations/github` in a submodule, your terraform run may [break in hard-to-troubleshoot ways](https://github.com/integrations/terraform-provider-github/issues/876#issuecomment-1303790559).


Suggested change

- You **must*- add a `required_providers` block to every module that will create resources with this provider. If you do not explicitly require `integrations/github` in a submodule, your terraform run may [break in hard-to-troubleshoot ways](https://github.com/integrations/terraform-provider-github/issues/876#issuecomment-1303790559).

- You **must** add a `required_providers` block to every module that will create resources with this provider. If you do not explicitly require `integrations/github` in a submodule, your terraform run may [break in hard-to-troubleshoot ways](https://github.com/integrations/terraform-provider-github/issues/876#issuecomment-1303790559).

stevehipwell added this to the v6.13.0 milestone Apr 29, 2026

stevehipwell requested a review from deiga April 29, 2026 14:52

stevehipwell self-assigned this Apr 29, 2026

stevehipwell added Type: Documentation Improvements or additions to documentation Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR labels Apr 29, 2026

stevehipwell force-pushed the plugin-docs-migrate branch from 7288bbb to 7ff5ce8 Compare April 29, 2026 14:56

chore: Use tf plugin docs

497864c

Signed-off-by: Steve Hipwell <[email protected]>

stevehipwell force-pushed the plugin-docs-migrate branch from 7ff5ce8 to 497864c Compare April 29, 2026 15:03

deiga requested changes May 1, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Use tf plugin docs#3380

chore: Use tf plugin docs#3380
stevehipwell wants to merge 1 commit intointegrations:mainfrom
stevehipwell:plugin-docs-migrate

stevehipwell commented Apr 29, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

deiga left a comment

Uh oh!

deiga Apr 29, 2026

Uh oh!

deiga Apr 29, 2026

Uh oh!

deiga Apr 29, 2026

Uh oh!

deiga Apr 29, 2026

Uh oh!

deiga Apr 29, 2026

Uh oh!

deiga Apr 30, 2026

Uh oh!

deiga May 1, 2026

Uh oh!

deiga May 1, 2026

Uh oh!

deiga May 1, 2026

Uh oh!

deiga May 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		GITHUB_OWNER: ${{ (matrix.mode == 'individual' && vars.GH_TEST_LOGIN) \|\|
		(matrix.mode == 'organization' && vars.GH_TEST_ORG_NAME) \|\| '' }}

	GITHUB_OWNER: ${{ (matrix.mode == 'individual' && vars.GH_TEST_LOGIN) \|\|
	(matrix.mode == 'organization' && vars.GH_TEST_ORG_NAME) \|\| '' }}
	GITHUB_OWNER: ${{ case(matrix.mode == 'individual', vars.GH_TEST_LOGIN, matrix.mode == 'organization', vars.GH_TEST_ORG_NAME, '') }}

		subject-checksums: ./dist/${{ github.event.repository.name }}_${{
		fromJSON(steps.goreleaser.outputs.metadata).version }}_SHA256SUMS

	".github/pull_request_template.md" = ["MD041"]
	".github/pull_request_template.md" = ["MD041", "MD009"]

	- You *must- add a `required_providers` block to every module that will create resources with this provider. If you do not explicitly require `integrations/github` in a submodule, your terraform run may [break in hard-to-troubleshoot ways](https://github.com/integrations/terraform-provider-github/issues/876#issuecomment-1303790559).
	- You must add a `required_providers` block to every module that will create resources with this provider. If you do not explicitly require `integrations/github` in a submodule, your terraform run may [break in hard-to-troubleshoot ways](https://github.com/integrations/terraform-provider-github/issues/876#issuecomment-1303790559).

Conversation

stevehipwell commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

deiga left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

stevehipwell commented Apr 29, 2026 •

edited

Loading