package
0.0.0-20221105224827-eae4eb0b2055
Repository: https://github.com/google/code-review-bot.git
Documentation: pkg.go.dev

# Functions

AuthorLogin retrieves the author from a `RepositoryCommit`.
CanonicalizeEmail returns a canonical version of the email address.
CommitterLogin retrieves the committer from a `RepositoryCommit`.
IsExternal computes whether the given commit should be processed by this tool, or if it should be covered by an external CLA management tool.
MatchAccount returns whether the provided account matches any of the accounts in the passed-in configuration for enforcing the CLA.
NewBasicClient returns a new client with only local methods bound; no external methods (which require an `http.Client`) are available so this client is only partially-constructed and can be used either in production with additional bindings added in `NewClient` or for testing by assigning mocked methods for the other services.
NewClient creates a client to work with the GitHub API.
ProcessCommit processes a single commit and returns compliance status and failure reason, if any.

# Constants

The CLA-related labels we expect to be predefined on a given repository.
The CLA-related labels we expect to be predefined on a given repository.
The CLA-related labels we expect to be predefined on a given repository.

# Structs

CommitStatus provides a signal as to the CLA-compliance of a specific commit.
GitHubClient provides an interface to the GitHub APIs used in this module.
GitHubProcessOrgRepoSpec is the specification of the work to be done for an organization and repo (possibly multiple PRs).
GitHubProcessSinglePullSpec is the specification of work to be processed for a single PR, carrying over the rest of the configuration settings from GitHubProcessOrgRepoSpec.
IssueClaLabelStatus provides the settings of CLA-related labels for a particular issue.
PullRequestStatus provides the CLA status for the entire PR, which considers all of the commits.
RepoClaLabelStatus provides the availability of CLA-related labels in the repo.

# Interfaces

GitHubUtilApi is the locally-defined API for interfacing with GitHub, using the methods in GitHubClient.
IssuesService is the subset of `github.IssuesService` used by this module.
OrganizationsService is the subset of `github.OrganizationsService` used by this module.
PullRequestsService is the subset of `github.PullRequestsService` used by this module.
RepositoriesService is the subset of `github.RepositoriesService` used by this module.