CyberdyneDevelopment.Mc3Po.SourceControl.Abstractions 0.1.0-preview.6

Mc3Po.SourceControl.Abstractions

Interfaces and models for source control operations.

Core Interfaces

ISourceControlService

public interface ISourceControlService
{
    // Repositories
    Task<IGenericResult<RepositoryInfo>> GetRepository(string repositoryId, CancellationToken ct = default);
    Task<IGenericResult<IReadOnlyList<RepositoryInfo>>> ListRepositories(ListRepositoriesRequest request, CancellationToken ct = default);

    // Branches
    Task<IGenericResult<BranchInfo>> CreateBranch(string repositoryId, string branchName, string fromRef, CancellationToken ct = default);
    Task<IGenericResult<IReadOnlyList<BranchInfo>>> ListBranches(string repositoryId, CancellationToken ct = default);

    // Pull Requests / Merge Requests
    Task<IGenericResult<PullRequestInfo>> CreatePullRequest(CreatePullRequestRequest request, CancellationToken ct = default);
    Task<IGenericResult<PullRequestInfo>> GetPullRequest(string repositoryId, string pullRequestId, CancellationToken ct = default);
    Task<IGenericResult<IReadOnlyList<PullRequestInfo>>> ListPullRequests(string repositoryId, PullRequestState? state = null, CancellationToken ct = default);
    Task<IGenericResult<PullRequestInfo>> MergePullRequest(string repositoryId, string pullRequestId, MergeOptions? options = null, CancellationToken ct = default);

    // Pipelines / Builds
    Task<IGenericResult<PipelineInfo>> GetPipeline(string repositoryId, string pipelineId, CancellationToken ct = default);
    Task<IGenericResult<IReadOnlyList<PipelineInfo>>> ListPipelines(string repositoryId, CancellationToken ct = default);

    // Commits
    Task<IGenericResult<IReadOnlyList<CommitInfo>>> ListCommits(string repositoryId, string? branch = null, int? limit = null, CancellationToken ct = default);
}

Models

RepositoryInfo

public class RepositoryInfo
{
    public string Id { get; set; }
    public string Name { get; set; }
    public string? FullPath { get; set; }
    public string? Description { get; set; }
    public string? DefaultBranch { get; set; }
    public string? CloneUrlHttps { get; set; }
    public string? CloneUrlSsh { get; set; }
    public string? WebUrl { get; set; }
}

BranchInfo

public class BranchInfo
{
    public string Name { get; set; }
    public string? CommitSha { get; set; }
    public bool IsDefault { get; set; }
    public bool IsProtected { get; set; }
}

PullRequestInfo

public class PullRequestInfo
{
    public string Id { get; set; }
    public int Number { get; set; }
    public string Title { get; set; }
    public string? Description { get; set; }
    public string SourceBranch { get; set; }
    public string TargetBranch { get; set; }
    public PullRequestState State { get; set; }
    public string? AuthorUsername { get; set; }
    public bool IsDraft { get; set; }
    public bool IsMergeable { get; set; }
    public string? WebUrl { get; set; }
    public DateTimeOffset? CreatedAt { get; set; }
    public DateTimeOffset? UpdatedAt { get; set; }
    public DateTimeOffset? MergedAt { get; set; }
}

PipelineInfo

public class PipelineInfo
{
    public string Id { get; set; }
    public int? Number { get; set; }
    public string? CommitSha { get; set; }
    public string? Ref { get; set; }
    public PipelineStatus Status { get; set; }
    public string? WebUrl { get; set; }
    public DateTimeOffset? CreatedAt { get; set; }
    public DateTimeOffset? StartedAt { get; set; }
    public DateTimeOffset? FinishedAt { get; set; }
}

CommitInfo

public class CommitInfo
{
    public string Sha { get; set; }
    public string ShortSha { get; set; }
    public string Message { get; set; }
    public string? AuthorName { get; set; }
    public string? AuthorEmail { get; set; }
    public DateTimeOffset? CommittedAt { get; set; }
    public string? WebUrl { get; set; }
}

Enums

PullRequestState

public enum PullRequestState
{
    Open,
    Closed,
    Merged
}

PipelineStatus

public enum PipelineStatus
{
    Pending,
    Running,
    Success,
    Failed,
    Cancelled
}

MergeMethod

public enum MergeMethod
{
    Merge,
    Squash,
    Rebase
}

Request Models

CreatePullRequestRequest

public class CreatePullRequestRequest
{
    public string RepositoryId { get; set; }
    public string SourceBranch { get; set; }
    public string TargetBranch { get; set; }
    public string Title { get; set; }
    public string? Description { get; set; }
    public bool IsDraft { get; set; }
}

MergeOptions

public class MergeOptions
{
    public MergeMethod Method { get; set; }
    public bool Squash { get; set; }
    public bool DeleteSourceBranch { get; set; }
    public string? CommitMessage { get; set; }
}

Dependencies

• FractalDataWorks.Results
• Microsoft.Extensions.Logging.Abstractions

Usage

This package is referenced by:

• Protocol implementations (GitLab, GitHub, Azure DevOps)
• Tools that need SC capabilities