woodpecker/web/src/lib/api/types/pipeline.ts

import { WebhookEvents } from './webhook';

export type PipelineError<D = unknown> = {
  type: string;
  message: string;
  data?: D;
  is_warning: boolean;
};

// A pipeline for a repository.
export type Pipeline = {
  id: number;

  // The pipeline number.
  // This number is specified within the context of the repository the pipeline belongs to and is unique within that.
  number: number;

  parent: number;

  event: WebhookEvents;

  //  The current status of the pipeline.
  status: PipelineStatus;

  errors?: PipelineError[];

  // When the pipeline request was received.
  created_at: number;

  // When the pipeline was updated last time in database.
  updated_at: number;

  // When the pipeline was enqueued.
  enqueued_at: number;

  // When the pipeline began execution.
  started_at: number;

  // When the pipeline was finished.
  finished_at: number;

  // Where the deployment should go.
  deploy_to: string;

  // The commit for the pipeline.
  commit: string;

  // The branch the commit was pushed to.
  branch: string;

  // The commit message.
  message: string;

  // When the commit was created.
  timestamp: number;

  // The alias for the commit.
  ref: string;

  // The mapping from the local repository to a branch in the forge.
  refspec: string;

  // The clone URL of the forge repository.
  clone_url: string;

  title: string;

  sender: string;

  // The login for the author of the commit.
  author: string;

  // The avatar for the author of the commit.
  author_avatar: string;

  //  email for the author of the commit.
  author_email: string;

  // This url will point to the repository state associated with the pipeline's commit.
  forge_url: string;

  signed: boolean;

  verified: boolean;

  reviewed_by: string;

  reviewed_at: number;

  // The steps associated with this pipeline.
  // A pipeline will have multiple steps if a matrix pipeline was used or if a rebuild was requested.
  workflows?: PipelineWorkflow[];

  changed_files?: string[];
};

export type PipelineStatus =
  | 'blocked'
  | 'declined'
  | 'error'
  | 'failure'
  | 'killed'
  | 'pending'
  | 'running'
  | 'skipped'
  | 'started'
  | 'success';

export type PipelineWorkflow = {
  id: number;
  pipeline_id: number;
  pid: number;
  name: string;
  state: PipelineStatus;
  environ?: Record<string, string>;
  start_time?: number;
  end_time?: number;
  agent_id?: number;
  error?: string;
  children: PipelineStep[];
};

export type PipelineStep = {
  id: number;
  uuid: string;
  pipeline_id: number;
  pid: number;
  ppid: number;
  name: string;
  state: PipelineStatus;
  exit_code: number;
  start_time?: number;
  end_time?: number;
  error?: string;
  type?: StepType;
};

export type PipelineLog = {
  id: number;
  step_id: number;
  time: number;
  line: number;
  data: string; // base64 encoded
  type: number;
};

export type PipelineFeed = Pipeline & {
  repo_id: number;
};

export enum StepType {
  Clone = 1,
  Service,
  Plugin,
  Commands,
  Cache,
}