Skip to content

docs: clarify GitHub App fetches template sources, OAuth still creates repos - #20534

Open
eon-pulumi-agent[bot] wants to merge 3 commits into
masterfrom
docs/org-templates-github-app-auth
Open

docs: clarify GitHub App fetches template sources, OAuth still creates repos#20534
eon-pulumi-agent[bot] wants to merge 3 commits into
masterfrom
docs/org-templates-github-app-auth

Conversation

@eon-pulumi-agent

Copy link
Copy Markdown
Contributor

What

Updates the "GitHub OAuth" prerequisite in Organization templates to reflect that fetching VCS-backed template sources can now go through the installed Pulumi GitHub app, while creating destination repositories still requires the user's OAuth authorization (to attribute the action to the human user).

Why

pulumi-service PR #39792 changed VCS-backed GitHub templates to prefer the org-level GitHub App for reads, falling back to user OAuth, while writes still go through OAuth. The docs previously described OAuth as covering both fetching and creating, which is now stale.

Notes

  • Kept the change to a single sentence tweak to avoid growing the page or altering its voice.
  • Did not reference the underlying LaunchDarkly flag (39610-template-org-auth), since that's an internal rollout detail rather than user-facing behavior.

Created with Eon

…s repos

pulumi-service#39792 changed VCS-backed GitHub templates to fetch
via the org-level GitHub App first, falling back to user OAuth.
Writes (creating destination repos) still require OAuth to
attribute the action to the human user.
@eon-pulumi-agent
eon-pulumi-agent Bot requested a review from fnune July 28, 2026 09:10
@github-actions github-actions Bot added review:triaging Claude Triage is currently classifying the PR domain:docs PR touches technical docs review:prose-flagged Trivial or frontmatter-only PR where triage's prose-check found possible spelling/grammar issues review:trivial Tiny prose-only change; skips Claude review labels Jul 28, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Triage prose check — possible issues in the diff. Full review is skipped (review:trivial); please double-check before merging.

  • [style] content/docs/idp/concepts/organization-templates.md:227 — wordiness: 'in order to' is too wordy.

This is a simplified spelling/grammar/style check in lieu of a full review. Reject false positives at your discretion.

@github-actions github-actions Bot removed the review:triaging Claude Triage is currently classifying the PR label Jul 28, 2026
@fnune

fnune commented Jul 28, 2026

Copy link
Copy Markdown
Member

@pulumi-eon I think there is more to this.

More specifically, this ensures that only repositories your GitHub user would normally have access can be used as template sources.

That's not really true, the GitHub app installation enables anyone with access to the Pulumi organization to read templates from sources installed by the organization, regardless of whether the individual GitHub user has access to the repository or not. The assumption is that if a Pulumi organization admin added a template source, it's for the whole Pulumi organization.

Please fix this and find any other outdated reasoning.

@eon-pulumi

eon-pulumi Bot commented Jul 28, 2026

Copy link
Copy Markdown

Done

I've addressed the issue raised by @fnune. Summary of changes to content/docs/idp/concepts/organization-templates.md:

  1. GitHub OAuth section: Removed the false claim that "only repositories your GitHub user would normally have access can be used as template sources." Replaced it with an accurate description of what OAuth actually governs — it ensures repositories are created using the individual user's own GitHub permissions, rather than the app's broader access.

  2. GitHub App section: Added an explicit explanation that since the app is installed and granted access at the organization level, any repository it can reach becomes usable as a template source by every member of the Pulumi organization — regardless of whether that individual's own GitHub user has access. This matches your point that an org admin adding a source is assumed to make it available org-wide.

  3. Found and fixed a second instance of the same outdated reasoning: further down in the "Organization settings" section, the doc said "Private repositories work similarly as long as your GitHub user has access to the repository" — the same incorrect assumption. Fixed to reference the GitHub App's org-level access instead.

Verified with node scripts/lint/lint-markdown.js (0 errors across all 1830 site files) and yarn prettier --check on the file — both pass. Changes are pushed to the PR branch.


View session

@pulumi-bot

pulumi-bot commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

The GitHub OAuth authorization ensures new repositories are created
using the individual GitHub user's own permissions, not the Pulumi
GitHub app's access. Reading (fetching) template sources works
differently: once an org admin installs the Pulumi GitHub app and
grants it access to a repository, that repository becomes usable as
a template source by every member of the Pulumi organization,
regardless of whether an individual member's own GitHub user has
access to it.

Corrects prior wording that incorrectly implied template source
access was gated by the individual GitHub user's own repository
permissions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain:docs PR touches technical docs review:prose-flagged Trivial or frontmatter-only PR where triage's prose-check found possible spelling/grammar issues review:trivial Tiny prose-only change; skips Claude review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants