Expand description
§CI/CD API
This module provides the CI/CD API endpoints for managing workflows, runs, artifacts, and status checks.
§Endpoint Overview
| Method | Path | Description |
|---|---|---|
| GET | /api/repos/{owner}/{name}/workflows | List workflows |
| POST | /api/repos/{owner}/{name}/workflows | Create/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}/runs | List runs |
| POST | /api/repos/{owner}/{name}/runs | Trigger manual run |
| GET | /api/repos/{owner}/{name}/runs/{id} | Get run details |
| POST | /api/repos/{owner}/{name}/runs/{id}/cancel | Cancel run |
| GET | /api/repos/{owner}/{name}/runs/{id}/jobs | List jobs in run |
| GET | /api/repos/{owner}/{name}/runs/{id}/jobs/{job}/logs | Get job logs |
| GET | /api/repos/{owner}/{name}/runs/{id}/artifacts | List artifacts |
| POST | /api/repos/{owner}/{name}/runs/{id}/artifacts | Upload artifact |
| GET | /api/repos/{owner}/{name}/runs/{id}/artifacts/{name} | Download artifact |
| GET | /api/repos/{owner}/{name}/commits/{sha}/status | Get combined status |
| GET | /api/repos/{owner}/{name}/commits/{sha}/statuses | List all statuses |
| POST | /api/repos/{owner}/{name}/commits/{sha}/statuses | Create status check |
Structs§
- Artifact
Response - Response for artifact info.
- CiState
- CI/CD state shared across handlers.
- Combined
Status Response - Response for combined status.
- Create
Status Request - Request to create a status check.
- Create
Workflow Request - Request to create/update a workflow.
- JobResponse
- Response for job info within a run.
- RunResponse
- Response for workflow run info.
- Status
Response - Response for status check info.
- Step
Response - Response for step info within a job.
- Trigger
RunRequest - Request to trigger a manual workflow run.
- Workflow
Response - Response for workflow info.
Enums§
- CiApi
Error - CI/CD error type.
Functions§
- ci_
routes - Creates the CI/CD routes.