Skip to main content

Module types

Module types 

Source
Expand description

GitHub API response types — deserialized from gh api JSON output.

Structs§

GitHubAnnotation
A check run annotation returned by the GitHub Checks API.
GitHubApp
The GitHub App that created a check run (check_run.app)
GitHubBranchRef
GitHubCheckRun
GitHubComment
GitHubIssue
GitHubLabel
GitHubPullRequest
Pull request details from the GitHub API. The mergeable field indicates if the PR can be merged:
GitHubReview
PR review state - “APPROVED”, “CHANGES_REQUESTED”, “COMMENTED”, “DISMISSED”
GitHubReviewComment
PR review comment on a specific line of code.
GitHubUser
PullRequestReview
A PR review with its associated comments.
RequiredStatusCheck
A required status check from classic branch protection or a ruleset

Functions§

extract_issue_number_from_url
Extract issue/PR number from a GitHub API URL.