Struct GithubService 

pub struct GithubService { /* private fields */ }

Structure used to communicate with a Github instance.

The API calls associated with this structure assume that the following permissions in GitHub have been granted to the application:

• Read & write
  • Checks
  • Issues
  • Pull requests
• Read-only
  • Repository contents
  • Repository metadata

User permissions should include read-only access to email addresses. Note that this does not currently work however and even with that permission, reading email addresses is being denied.

Implementations

impl GithubService

pub fn new(github: Github) -> Result<Self, HostingServiceError>

Create a new Github communication channel.

pub fn split_project(project: &str) -> Result<(&str, &str), HostingServiceError>

Splits a project name in to an owner, name pair.

pub fn post_comment<C>( &self, owner: &str, id: String, content: C, ) -> Result<(), HostingServiceError>

where C: Into<String>,

Create a comment.

pub fn check_rate_limits<R>(rate_limit: &Option<R>, name: &str)

where R: Into<RateLimitInfo> + Clone,

Check the rate limiting for a query.

pub fn github(&self) -> &Github

Access the GitHub client.

Trait Implementations

impl Debug for GithubService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HostingService for GithubService

fn fetch_mr( &self, git: &GitContext, mr: &MergeRequest, ) -> Result<(), HostingServiceError>

Fetch a merge request into a given git context.

fn service_user(&self) -> &User

The user the service is acting as.

fn user(&self, project: &str, user: &str) -> Result<User, HostingServiceError>

Get a user by name.

fn commit( &self, project: &str, commit: &CommitId, ) -> Result<Commit, HostingServiceError>

Get a commit for a project.

fn merge_request( &self, project: &str, id: u64, ) -> Result<MergeRequest, HostingServiceError>

Get a merge request on a project.

fn repo(&self, project: &str) -> Result<Repo, HostingServiceError>

Get a repository by name.

fn get_mr_comments( &self, mr: &MergeRequest, ) -> Result<Vec<Comment>, HostingServiceError>

Get comments for a merge request.

fn post_mr_comment( &self, mr: &MergeRequest, content: &str, ) -> Result<(), HostingServiceError>

Add a comment to a merge request.

fn get_commit_statuses( &self, commit: &Commit, ) -> Result<Vec<CommitStatus>, HostingServiceError>

Get the latest commit statuses for a commit.

fn post_commit_status( &self, status: PendingCommitStatus<'_>, ) -> Result<(), HostingServiceError>

Create a commit status.

fn post_review( &self, status: PendingCommitStatus<'_>, _: &MergeRequest, description: &str, ) -> Result<(), HostingServiceError>

Create a review of a merge request.

fn get_mr_awards( &self, mr: &MergeRequest, ) -> Result<Vec<Award>, HostingServiceError>

Get awards on a merge request.

fn issues_closed_by_mr( &self, mr: &MergeRequest, ) -> Result<Vec<Issue>, HostingServiceError>

Get issues which are closed by a merge request.

fn add_issue_labels( &self, issue: &Issue, labels: &[&str], ) -> Result<(), HostingServiceError>

Add labels to an issue.

fn remove_issue_labels( &self, issue: &Issue, labels: &[&str], ) -> Result<(), HostingServiceError>

Remove labels to an issue.

fn fetch_commit( &self, git: &GitContext, commit: &Commit, ) -> Result<(), HostingServiceError>

Fetch a commit into a given git context.

fn suppress_ci_push_option(&self, branch: &str) -> Option<String>

Create a push option to suppress the CI for a branch when pushing.

fn as_pipeline_service( self: Arc<Self>, ) -> Option<Arc<dyn HostedPipelineService>>

Get more specific hosting service access.

fn repo_as_user( &self, repo: &Repo, user: &User, reason: &str, ) -> Result<Option<Repo>, HostingServiceError>

Get a repo as a user.