Module ci_api

Module ci_api 

Source
Expand description

§CI/CD API

This module provides the CI/CD API endpoints for managing workflows, runs, artifacts, and status checks.

§Endpoint Overview

MethodPathDescription
GET/api/repos/{owner}/{name}/workflowsList workflows
POST/api/repos/{owner}/{name}/workflowsCreate/update workflow
GET/api/repos/{owner}/{name}/workflows/{id}Get workflow
DELETE/api/repos/{owner}/{name}/workflows/{id}Delete workflow
GET/api/repos/{owner}/{name}/runsList runs
POST/api/repos/{owner}/{name}/runsTrigger manual run
GET/api/repos/{owner}/{name}/runs/{id}Get run details
POST/api/repos/{owner}/{name}/runs/{id}/cancelCancel run
GET/api/repos/{owner}/{name}/runs/{id}/jobsList jobs in run
GET/api/repos/{owner}/{name}/runs/{id}/jobs/{job}/logsGet job logs
GET/api/repos/{owner}/{name}/runs/{id}/artifactsList artifacts
POST/api/repos/{owner}/{name}/runs/{id}/artifactsUpload artifact
GET/api/repos/{owner}/{name}/runs/{id}/artifacts/{name}Download artifact
GET/api/repos/{owner}/{name}/commits/{sha}/statusGet combined status
GET/api/repos/{owner}/{name}/commits/{sha}/statusesList all statuses
POST/api/repos/{owner}/{name}/commits/{sha}/statusesCreate status check

Structs§

ArtifactResponse
Response for artifact info.
CiState
CI/CD state shared across handlers.
CombinedStatusResponse
Response for combined status.
CreateStatusRequest
Request to create a status check.
CreateWorkflowRequest
Request to create/update a workflow.
JobResponse
Response for job info within a run.
RunResponse
Response for workflow run info.
StatusResponse
Response for status check info.
StepResponse
Response for step info within a job.
TriggerRunRequest
Request to trigger a manual workflow run.
WorkflowResponse
Response for workflow info.

Enums§

CiApiError
CI/CD error type.

Functions§

ci_routes
Creates the CI/CD routes.