Skip to main content

Crate rung_github

Crate rung_github

Expand description

§rung-github

GitHub API integration for Rung, providing PR management and CI status fetching capabilities.

§Architecture

The crate provides both a concrete GitHubClient implementation and a GitHubApi trait for dependency injection and testing.

§Security

Authentication tokens are stored using SecretString which automatically zeroizes memory when dropped, reducing credential exposure in memory dumps.

Structs§

CheckRun: A CI check run.
CreateComment: Request to create an issue/PR comment.
CreatePullRequest: Request to create a pull request.
GitHubClient: GitHub API client.
IssueComment: A comment on an issue or pull request.
MergePullRequest: Request to merge a pull request.
MergeResult: Result of merging a pull request.
PullRequest: A GitHub Pull Request.
UpdateComment: Request to update an issue/PR comment.
UpdatePullRequest: Request to update a pull request.

Enums§

Auth: Authentication method for GitHub API.
CheckStatus: Status of a CI check.
Error: Errors that can occur during GitHub API operations.
MergeMethod: Method used to merge a pull request.
PullRequestState: State of a pull request.

Traits§

GitHubApi: Trait for GitHub API operations.

Type Aliases§

Result: Result type alias using Error.
SecretString: Secret string type.