Repository navigation
[CXH-3499] - Docs: baton-github-enterprise — say it covers GHES and GHEC, highlight unique capabilities, fix auth-option inconsistency - #33
Conversation
Superseded — see the current review report for commit
|
Superseded — see the current review report for commit
|
There was a problem hiding this comment.
No blocking issues found — see the full review report
Superseded — see the current review report for commit
|
Superseded — see the current review report for commit
|
There was a problem hiding this comment.
No blocking issues found — see the full review report
luisina-santos
left a comment
There was a problem hiding this comment.
Holding this until the shared "Choose a GitHub connector" guide from CXH-3497 exists. That guide isn't written yet, and the parent issue requires all three connector pages to link it.
Once the guide is published, add the link to the note at the top of each page and merge these three PRs together:
- ConductorOne/baton-github#196
- #33
- ConductorOne/baton-axiomatic-github-enterprise-cloud#16
… and footnotes Keep only real differentiators in the top note, state the Instance URL value for GitHub Enterprise Cloud without the testing caveat, and drop the footnote that called organization roles enterprise licenses. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Superseded — see the current review report for commit
|
Connector PR Review: [CXH-3499] - Docs: baton-github-enterprise — say it covers GHES and GHEC, highlight unique capabilities, fix auth-option inconsistencyBlocking Issues: 0 | Suggestions: 1 | Threads Resolved: 0 Review SummaryThis PR only changes I scanned the full PR diff for security and correctness. There is no code, config, or dependency change. I checked the doc claims against the code:
From the trusted repo-local criteria, only the documentation-staleness checks (D1–D4) and BP3 apply. The docs now match the config fields, and the auth options match the PAT and GitHub App auth groups. The logging, error-wrapping, sync data-loss, provisioning and breaking-change sections do not apply because no code changed. Gap: I could not check that the new internal link resolves, because the docs site is not in this repo. Security IssuesNone found. Correctness IssuesNone found. Suggestions
Prompt for AI agentsReviewed commit: |
There was a problem hiding this comment.
No blocking issues found — see the full review report
Intent
Docs for CXH-3499 (sub-issue of CXH-3497): make
docs/connector.mdxsay the connector covers both GHES and GHEC, list what is unique to it, fix the PAT/GitHub App auth inconsistency, state the GHEC instance URL value, and document EMU behavior.Changes (docs/connector.mdx only)
https://github.com(the default); field marked required (PAT and App tabs).*.ghe.comis not mentioned.Verified in code (vendored baton-github v0.4.8)
pkg/config/config.go(instance-url): required, defaulthttps://github.com.vendor/.../connector/connector.go:318andcustomclient/enterprise_admin.go:34,118: exacthttps://github.com(trailing slash trimmed) uses the public API; any other value is treated as an enterprise host.connector.go:662-678(isEnterpriseCloud): github.com / ghe.com are Cloud, anything else is Server;connector.go:~530: Owner role on Server is rejected.invitation.go:248-265account provisioning =CreateOrgInvitation;invitation.go:290-291EMU error ("accounts are provisioned by the IdP"), triggered by a 422 matching "managed by an enterprise"/"enterprise managed" (:495).baton_capabilities.json: enterprise_role sync+provision, license sync, invitation account provisioning + delete.connector.go:~283,295: App auth = single org; license sync is PAT-only.Open items
/baton/choose-github-connector, added in Add a guide for choosing a GitHub connector docs#632. Merge that PR first, or together with this one and the two sibling PRs ([CXH-3498] - Docs: baton-github — add "when to use" guidance and document missing capabilities baton-github#196, ConductorOne/baton-axiomatic-github-enterprise-cloud#16), so the link doesn't 404.*.ghe.com) is untested; the page gives thegithub.comvalue only.Fixes CXH-3499
🤖 Generated with AI