Interface IBuildService

Namespace

Ando.Server.Services

Assembly

Ando.Server.dll

Service for managing builds.

public interface IBuildService

Methods

CancelBuildAsync(int)

Cancels a running build.

Task<bool> CancelBuildAsync(int buildId)

Parameters

buildId int

Returns

Task<bool>

True if the build was cancelled.

GetBuildAsync(int)

Gets a build by ID with related project data.

Task<Build?> GetBuildAsync(int buildId)

Parameters

buildId int

Returns

Task<Build>

GetBuildsForProjectAsync(int, int, int)

Gets builds for a project with pagination.

Task<IReadOnlyList<Build>> GetBuildsForProjectAsync(int projectId, int skip = 0, int take = 20)

Parameters

projectId int

skip int

take int

Returns

Task<IReadOnlyList<Build>>

GetRecentBuildsForUserAsync(int, int)

Gets recent builds across all projects for a user.

Task<IReadOnlyList<Build>> GetRecentBuildsForUserAsync(int userId, int take = 10)

Parameters

userId int

take int

Returns

Task<IReadOnlyList<Build>>

QueueBuildAsync(int, string, string, BuildTrigger, string?, string?, int?, string?)

Queues a new build for a project.

Task<int> QueueBuildAsync(int projectId, string commitSha, string branch, BuildTrigger trigger, string? commitMessage = null, string? commitAuthor = null, int? pullRequestNumber = null, string? profile = null)

Parameters

projectId int

Project to build.

commitSha string

Commit SHA to build.

branch string

Branch name.

trigger BuildTrigger

What triggered the build.

commitMessage string

Optional commit message.

commitAuthor string

Optional commit author.

pullRequestNumber int?

Optional PR number if this is a PR build.

profile string

Returns

Task<int>

The new build ID.

RetryBuildAsync(int)

Retries a failed or cancelled build.

Task<int> RetryBuildAsync(int buildId)

Parameters

buildId int

Returns

Task<int>

The new build ID.

UpdateBuildStatusAsync(int, BuildStatus, string?, int?, int?, int?)

Updates build status and related fields.

Task UpdateBuildStatusAsync(int buildId, BuildStatus status, string? errorMessage = null, int? stepsTotal = null, int? stepsCompleted = null, int? stepsFailed = null)

Parameters

buildId int

status BuildStatus

errorMessage string

stepsTotal int?

stepsCompleted int?

stepsFailed int?

Returns

Task