run

package
v1.0.42663-pre Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package run contains business logic for run-level operations.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Cancel

func Cancel(ctx context.Context, client *apiclient.Client, runID uuid.UUID) error

Cancel cancels a run by cancelling each of its active workflows. The CircleCI API has no run-level cancel endpoint; cancellation operates at the workflow level via POST /api/v3/workflows/{id}/cancel.

Returns ErrNothingToCancel when the run exists but all workflows are already in a terminal state.

Types

type ErrNothingToCancel

type ErrNothingToCancel struct {
	RunID uuid.UUID
}

ErrNothingToCancel is returned by Cancel when the run exists but all of its workflows are already in a terminal state.

func (*ErrNothingToCancel) Error

func (e *ErrNothingToCancel) Error() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL