Skip to content

BED-9661: refresh GitHub node and edge documentation - #55

Merged
jaredcatkinson merged 2 commits into
mainfrom
chore/BED-9661-node-edge-docs
Sep 8, 2026
Merged

jaredcatkinson merged 2 commits into
mainfrom
chore/BED-9661-node-edge-docs

Conversation

@jaredcatkinson

Copy link
Copy Markdown
Contributor

Summary

  • refresh all GH_ node and edge description files to use the GitHound-style structure
  • add missing documentation for current enterprise and generic GH_ kinds
  • add a generator and coverage test so future GH_ schema additions require docs

Testing

  • HOME=/private/tmp .venv/bin/python -m pytest tests/test_description_docs.py
  • HOME=/private/tmp .venv/bin/python -m ruff check scripts/generate_gh_description_docs.py tests/test_description_docs.py
  • git diff --check

@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Warning

Review limit reached

  • Run on-demand review

On-demand reviews are free for the next 16 days. After that, they cost $0.25 per reviewed file.

View limit details

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: f91fb11e-f84b-4098-8dcd-b9bc6ca53108

📥 Commits

Reviewing files that changed from the base of the PR and between fd61122 and 6e11786.

📒 Files selected for processing (195)
  • descriptions/edges/GH_AddAssignee.md
  • descriptions/edges/GH_AddCollaborator.md
  • descriptions/edges/GH_AddLabel.md
  • descriptions/edges/GH_AddMember.md
  • descriptions/edges/GH_AdminTo.md
  • descriptions/edges/GH_ApprovesDeploymentTo.md
  • descriptions/edges/GH_AssignedTo.md
  • descriptions/edges/GH_BypassBranchProtection.md
  • descriptions/edges/GH_BypassPullRequestAllowances.md
  • descriptions/edges/GH_CallsWorkflow.md
  • descriptions/edges/GH_CanAccess.md
  • descriptions/edges/GH_CanAssumeIdentity.md
  • descriptions/edges/GH_CanCreateBranch.md
  • descriptions/edges/GH_CanCreateEnvironment.md
  • descriptions/edges/GH_CanCreateInternalRepositories.md
  • descriptions/edges/GH_CanCreatePrivateRepositories.md
  • descriptions/edges/GH_CanCreatePublicRepositories.md
  • descriptions/edges/GH_CanCreateRepositories.md
  • descriptions/edges/GH_CanCreateRepositoryWithRunnerAccess.md
  • descriptions/edges/GH_CanDeployToEnvironment.md
  • descriptions/edges/GH_CanEditEnvironment.md
  • descriptions/edges/GH_CanEditProtection.md
  • descriptions/edges/GH_CanPwnRequest.md
  • descriptions/edges/GH_CanReadSecret.md
  • descriptions/edges/GH_CanReadSecretScanningAlert.md
  • descriptions/edges/GH_CanUseRunner.md
  • descriptions/edges/GH_CanWriteBranch.md
  • descriptions/edges/GH_CloseDiscussion.md
  • descriptions/edges/GH_CloseIssue.md
  • descriptions/edges/GH_ClosePullRequest.md
  • descriptions/edges/GH_Contains.md
  • descriptions/edges/GH_ConvertIssuesToDiscussions.md
  • descriptions/edges/GH_CreateDiscussionCategory.md
  • descriptions/edges/GH_CreateEnterpriseOrganizations.md
  • descriptions/edges/GH_CreateRepository.md
  • descriptions/edges/GH_CreateSoloMergeQueueEntry.md
  • descriptions/edges/GH_CreateTag.md
  • descriptions/edges/GH_CreateTeam.md
  • descriptions/edges/GH_DeleteAlertsCodeScanning.md
  • descriptions/edges/GH_DeleteDiscussion.md
  • descriptions/edges/GH_DeleteDiscussionComment.md
  • descriptions/edges/GH_DeleteIssue.md
  • descriptions/edges/GH_DeleteTag.md
  • descriptions/edges/GH_DependsOn.md
  • descriptions/edges/GH_DeploysTo.md
  • descriptions/edges/GH_EditCategoryOnDiscussion.md
  • descriptions/edges/GH_EditDiscussionCategory.md
  • descriptions/edges/GH_EditDiscussionComment.md
  • descriptions/edges/GH_EditEnterpriseCustomPropertiesForOrganizations.md
  • descriptions/edges/GH_EditRepoAnnouncementBanners.md
  • descriptions/edges/GH_EditRepoCustomPropertiesValues.md
  • descriptions/edges/GH_EditRepoMetadata.md
  • descriptions/edges/GH_EditRepoProtections.md
  • descriptions/edges/GH_HasBaseRole.md
  • descriptions/edges/GH_HasBranch.md
  • descriptions/edges/GH_HasEnvironment.md
  • descriptions/edges/GH_HasExternalIdentity.md
  • descriptions/edges/GH_HasJob.md
  • descriptions/edges/GH_HasMember.md
  • descriptions/edges/GH_HasPersonalAccessToken.md
  • descriptions/edges/GH_HasPersonalAccessTokenRequest.md
  • descriptions/edges/GH_HasRole.md
  • descriptions/edges/GH_HasRunner.md
  • descriptions/edges/GH_HasSamlIdentityProvider.md
  • descriptions/edges/GH_HasSecret.md
  • descriptions/edges/GH_HasStep.md
  • descriptions/edges/GH_HasVariable.md
  • descriptions/edges/GH_HasWorkflow.md
  • descriptions/edges/GH_InheritedFrom.md
  • descriptions/edges/GH_InstalledAs.md
  • descriptions/edges/GH_InviteMember.md
  • descriptions/edges/GH_IsEligibleFor.md
  • descriptions/edges/GH_JumpMergeQueue.md
  • descriptions/edges/GH_ManageDeployKeys.md
  • descriptions/edges/GH_ManageDiscussionBadges.md
  • descriptions/edges/GH_ManageEnterpriseAdmins.md
  • descriptions/edges/GH_ManageEnterpriseIdentityProvider.md
  • descriptions/edges/GH_ManageEnterpriseMembers.md
  • descriptions/edges/GH_ManageEnterpriseOrganizationAdmins.md
  • descriptions/edges/GH_ManageEnterpriseOrganizations.md
  • descriptions/edges/GH_ManageEnterpriseReferrals.md
  • descriptions/edges/GH_ManageEnterpriseTeams.md
  • descriptions/edges/GH_ManageOrganizationWebhooks.md
  • descriptions/edges/GH_ManageRepoSecurityProducts.md
  • descriptions/edges/GH_ManageSecurityProducts.md
  • descriptions/edges/GH_ManageSettingsMergeTypes.md
  • descriptions/edges/GH_ManageSettingsPages.md
  • descriptions/edges/GH_ManageSettingsProjects.md
  • descriptions/edges/GH_ManageSettingsWiki.md
  • descriptions/edges/GH_ManageTopics.md
  • descriptions/edges/GH_ManageWebhooks.md
  • descriptions/edges/GH_MapsToUser.md
  • descriptions/edges/GH_MarkAsDuplicate.md
  • descriptions/edges/GH_MatchesEnvironmentPolicy.md
  • descriptions/edges/GH_MemberOf.md
  • descriptions/edges/GH_OrgBypassCodeScanningDismissalRequests.md
  • descriptions/edges/GH_OrgBypassSecretScanningClosureRequests.md
  • descriptions/edges/GH_OrgReviewAndManageSecretScanningBypassRequests.md
  • descriptions/edges/GH_OrgReviewAndManageSecretScanningClosureRequests.md
  • descriptions/edges/GH_Owns.md
  • descriptions/edges/GH_ProtectedBy.md
  • descriptions/edges/GH_PushProtectedBranch.md
  • descriptions/edges/GH_ReadCodeScanning.md
  • descriptions/edges/GH_ReadEnterpriseAuditLog.md
  • descriptions/edges/GH_ReadEnterpriseDomainVerification.md
  • descriptions/edges/GH_ReadEnterpriseMembers.md
  • descriptions/edges/GH_ReadEnterpriseOrgProjects.md
  • descriptions/edges/GH_ReadEnterpriseOrganizationAdmin.md
  • descriptions/edges/GH_ReadOrganizationActionsUsageMetrics.md
  • descriptions/edges/GH_ReadOrganizationCustomOrgRole.md
  • descriptions/edges/GH_ReadOrganizationCustomRepoRole.md
  • descriptions/edges/GH_ReadRepoContents.md
  • descriptions/edges/GH_RemoveAssignee.md
  • descriptions/edges/GH_RemoveLabel.md
  • descriptions/edges/GH_ReopenDiscussion.md
  • descriptions/edges/GH_ReopenIssue.md
  • descriptions/edges/GH_ReopenPullRequest.md
  • descriptions/edges/GH_RequestPrReview.md
  • descriptions/edges/GH_ResolveDependabotAlerts.md
  • descriptions/edges/GH_ResolveSecretScanningAlerts.md
  • descriptions/edges/GH_RestrictionsCanPush.md
  • descriptions/edges/GH_RunOrgMigration.md
  • descriptions/edges/GH_SetEnterpriseInteractionLimits.md
  • descriptions/edges/GH_SetInteractionLimits.md
  • descriptions/edges/GH_SetIssueType.md
  • descriptions/edges/GH_SetMilestone.md
  • descriptions/edges/GH_SetSocialPreview.md
  • descriptions/edges/GH_SyncedTo.md
  • descriptions/edges/GH_ToggleDiscussionAnswer.md
  • descriptions/edges/GH_ToggleDiscussionCommentMinimize.md
  • descriptions/edges/GH_TransferRepository.md
  • descriptions/edges/GH_UsesSecret.md
  • descriptions/edges/GH_UsesVariable.md
  • descriptions/edges/GH_ValidToken.md
  • descriptions/edges/GH_ViewDependabotAlerts.md
  • descriptions/edges/GH_ViewEnterpriseActionsUsageMetrics.md
  • descriptions/edges/GH_ViewEnterpriseBilling.md
  • descriptions/edges/GH_ViewEnterpriseSecretScanningAlerts.md
  • descriptions/edges/GH_ViewSecretScanningAlerts.md
  • descriptions/edges/GH_WriteCodeScanning.md
  • descriptions/edges/GH_WriteEnterpriseActionsPolicies.md
  • descriptions/edges/GH_WriteEnterpriseBilling.md
  • descriptions/edges/GH_WriteEnterprisePersonalAccessTokenPolicies.md
  • descriptions/edges/GH_WriteEnterpriseSso.md
  • descriptions/edges/GH_WriteEnterpriseTeamMembers.md
  • descriptions/edges/GH_WriteOrganizationActionsSecrets.md
  • descriptions/edges/GH_WriteOrganizationActionsSettings.md
  • descriptions/edges/GH_WriteOrganizationActionsVariables.md
  • descriptions/edges/GH_WriteOrganizationCustomOrgRole.md
  • descriptions/edges/GH_WriteOrganizationCustomRepoRole.md
  • descriptions/edges/GH_WriteOrganizationNetworkConfigurations.md
  • descriptions/edges/GH_WriteRepoContents.md
  • descriptions/edges/GH_WriteRepoPullRequests.md
  • descriptions/nodes/GH_App.md
  • descriptions/nodes/GH_AppInstallation.md
  • descriptions/nodes/GH_Branch.md
  • descriptions/nodes/GH_BranchProtectionRule.md
  • descriptions/nodes/GH_Enterprise.md
  • descriptions/nodes/GH_EnterpriseManagedUser.md
  • descriptions/nodes/GH_EnterpriseRole.md
  • descriptions/nodes/GH_EnterpriseRunner.md
  • descriptions/nodes/GH_EnterpriseRunnerGroup.md
  • descriptions/nodes/GH_EnterpriseTeam.md
  • descriptions/nodes/GH_Environment.md
  • descriptions/nodes/GH_EnvironmentBranchPolicy.md
  • descriptions/nodes/GH_EnvironmentSecret.md
  • descriptions/nodes/GH_EnvironmentVariable.md
  • descriptions/nodes/GH_ExternalIdentity.md
  • descriptions/nodes/GH_OrgRole.md
  • descriptions/nodes/GH_OrgRunner.md
  • descriptions/nodes/GH_OrgRunnerGroup.md
  • descriptions/nodes/GH_OrgSecret.md
  • descriptions/nodes/GH_OrgVariable.md
  • descriptions/nodes/GH_Organization.md
  • descriptions/nodes/GH_PersonalAccessToken.md
  • descriptions/nodes/GH_PersonalAccessTokenRequest.md
  • descriptions/nodes/GH_RepoRole.md
  • descriptions/nodes/GH_RepoRunner.md
  • descriptions/nodes/GH_RepoSecret.md
  • descriptions/nodes/GH_RepoVariable.md
  • descriptions/nodes/GH_Repository.md
  • descriptions/nodes/GH_Runner.md
  • descriptions/nodes/GH_RunnerGroup.md
  • descriptions/nodes/GH_SamlIdentityProvider.md
  • descriptions/nodes/GH_Secret.md
  • descriptions/nodes/GH_SecretScanningAlert.md
  • descriptions/nodes/GH_Team.md
  • descriptions/nodes/GH_TeamRole.md
  • descriptions/nodes/GH_User.md
  • descriptions/nodes/GH_Variable.md
  • descriptions/nodes/GH_Workflow.md
  • descriptions/nodes/GH_WorkflowJob.md
  • descriptions/nodes/GH_WorkflowStep.md
  • scripts/generate_gh_description_docs.py
  • tests/test_description_docs.py

Comment @coderabbitai help to get the list of available commands.

@jaredcatkinson
jaredcatkinson merged commit 757c96b into main Sep 8, 2026
2 checks passed
@jaredcatkinson
jaredcatkinson deleted the chore/BED-9661-node-edge-docs branch September 8, 2026 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants