Skip to content

chore: Use tf plugin docs - #3380

Merged
stevehipwell merged 3 commits into
integrations:mainfrom
stevehipwell:plugin-docs-migrate
May 5, 2026
Merged

stevehipwell merged 3 commits into
integrations:mainfrom
stevehipwell:plugin-docs-migrate

Conversation

@stevehipwell

@stevehipwell stevehipwell commented Apr 29, 2026 •

Copy link
Copy Markdown
Collaborator

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

@stevehipwell stevehipwell added this to the v6.13.0 milestone Apr 29, 2026
@stevehipwell
stevehipwell requested a review from deiga April 29, 2026 14:52
@stevehipwell stevehipwell self-assigned this Apr 29, 2026
@stevehipwell stevehipwell added Type: Documentation Improvements or additions to documentation Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR labels Apr 29, 2026
@github-actions

Copy link
Copy Markdown

👋 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 <steve.hipwell@gmail.com>

@deiga deiga left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

Comment thread .github/workflows/release.yaml Resolved
Comment thread .rumdl.toml Resolved
Comment thread docs/resources/repository.md Resolved
Comment thread docs/index.md Resolved
@stevehipwell

Copy link
Copy Markdown
Collaborator Author

@deiga could you please re-review.

@stevehipwell
stevehipwell requested a review from deiga May 5, 2026 11:45

@deiga deiga left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job!

@stevehipwell

Copy link
Copy Markdown
Collaborator Author

@robert-crandall please could you review/approve this PR?

@stevehipwell
stevehipwell merged commit 091a326 into integrations:main May 5, 2026
9 checks passed
@stevehipwell
stevehipwell deleted the plugin-docs-migrate branch May 5, 2026 16:35
allandegnan added a commit to alphagov/terraform-provider-github that referenced this pull request May 21, 2026
Templates added in PR integrations#3380 (tfplugindocs migration) — generate
docs/resources/*.md from templates/resources/*.md.tmpl. The previously
hand-written docs file is replaced with the regenerated output.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
austenstone pushed a commit to austenstone/terraform-provider-github that referenced this pull request Jun 9, 2026
* chore: Use tf plugin docs

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>

* fixup! chore: Use tf plugin docs

* fixup! chore: Use tf plugin docs

---------

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>
austenstone pushed a commit to austenstone/terraform-provider-github that referenced this pull request Jun 9, 2026
* chore: Use tf plugin docs

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>

* fixup! chore: Use tf plugin docs

* fixup! chore: Use tf plugin docs

---------

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>
sprioriello pushed a commit to sprioriello/terraform-provider-github that referenced this pull request Jun 10, 2026
…ns#3380)

- remove website/docs/r pages (no longer published since integrations#3380)
- add examples/resources/ + templates/resources/ for both resources
- commit generated docs/resources pages from make generatedocs
corymhall pushed a commit to pulumi/pulumi-github that referenced this pull request Aug 14, 2026
Unblocks the nightly `upgrade-provider` job and pulls in upstream
v6.13.0.

## Why this was stuck

Upstream v6.13.0 refactored the provider entry point in
[#3440](integrations/terraform-provider-github#3440),
replacing the parameterless `github.Provider()` with
`github.NewProvider(version, commit)`, which returns the provider
factory.

The nightly [Upgrade
provider](https://github.com/pulumi/pulumi-github/actions/workflows/upgrade-provider.yml)
job rebases onto the new tag fine, then dies in codegen:

```
./scripts/upstream.sh rebase -o refs/tags/v6.13.0: done
error: upgrade-provider executed `make tfgen` which failed: exit status 2:
./resources.go:78:33: undefined: github.Provider
make: *** [Makefile:323: bin/pulumi-tfgen-github] Error 1
```

It has failed every night since v6.13.0 was released on 2026-07-08, so
the bridge is still pinned to upstream v6.12.1 and none of the fixes
below have shipped.

## Changes

- `provider/resources.go`: use `github.NewProvider(version.Version,
"")()`. `version` and `commit` only feed the upstream User-Agent and
debug logging; the bridge appends its own Pulumi User-Agent, so the
commit is left empty. This is the only hand-written change.
- `upstream`: v6.12.1 → v6.13.0 (via `upstream.sh checkout` / `rebase -o
refs/tags/v6.13.0` / `check_in`).
- Regenerated schema, all five SDKs, and `docs/_index.md`.

## Notable upstream fixes pulled in

- **`github_team_repository` delete now treats a 404 from GitHub as a
successful delete**
([#3524](integrations/terraform-provider-github#3524)).
Previously the 404 branch only recovered from repository *renames*: it
re-read the repo and retried the delete only when `.GetName()` differed.
A repository transferred to a **different organization** keeps its name,
so the retry was skipped and the original 404 surfaced as a hard error.
Any stack still holding that resource in state is then permanently
wedged — every subsequent update fails on the same undeletable resource,
and the only escape is `pulumi state delete`.
- Fixes a nil-pointer panic in that same delete path when the API call
fails at the transport layer
([#3518](integrations/terraform-provider-github#3518)).
- `github_team_members` deletion is skipped when the parent team is
already gone
([#3461](integrations/terraform-provider-github#3461)).

## Schema impact

Additive — nothing removed or retyped (verified by diffing schema keys
against `master`):

- New provider config options: `cachePath`, `legacyClient`
- New resource properties: `BranchDefault.repositoryId`,
`BranchDefault.waitForRename`,
`RepositoryCollaborators.ownerConfigured`,
`RepositoryCustomProperty.repositoryId`, `TeamMembers.teamSlug`

The bulk of the schema and `docs/_index.md` diff is upstream's migration
to tfplugindocs
([#3380](integrations/terraform-provider-github#3380))
and its rewritten provider docs and examples
([#3440](integrations/terraform-provider-github#3440))
— restyled descriptions, and the overview example changing from
`github_membership` to `getRepository` because upstream replaced
`examples/provider/example_1.tf`/`example_2.tf` with a single
`provider.tf`.

## Verification

- `make tfgen` succeeds; example conversion 93.39% (1314/1407)
- All five SDKs generated; Go SDK compiles
- `dotnet build` not run locally (unrelated local NuGet source
misconfiguration) — leaving that to CI
- Acceptance tests not run locally

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Documentation Improvements or additions to documentation Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR

Projects

None yet

3 participants