Skip to main content Link Search Menu Expand Document (external link)

ActionSummary overview

ActionSummary service for building GitHub Actions job summaries.

Provides a chainable API for building rich markdown summaries:

  • Text content (raw, headings, code blocks)
  • Lists and tables
  • Collapsible details sections
  • Images and links
  • Buffer management and file operations

Added in v1.0.0


Table of contents


accessors

clear

Signature

export declare const clear: Effect.Effect<ActionSummary, ActionSummaryError, ActionSummary>

Added in v1.0.0

write

Signature

export declare const write: (options?: {
  overwrite?: boolean
}) => Effect.Effect<ActionSummary, ActionSummaryError, ActionSummary>

Added in v1.0.0

context

ActionSummary

Signature

export declare const ActionSummary: Tag<ActionSummary, ActionSummary>

Added in v1.0.0

layers

layer

Signature

export declare const layer: Layer.Layer<ActionSummary, never, never>

Added in v1.0.0

models

ActionSummary (interface)

Signature

export interface ActionSummary {
  readonly [TypeId]: typeof TypeId

  // Content methods (chainable, returns new ActionSummary)
  readonly addRaw: (text: string, addEOL?: boolean) => ActionSummary
  readonly addEOL: () => ActionSummary
  readonly addHeading: (text: string, level?: 1 | 2 | 3 | 4 | 5 | 6) => ActionSummary
  readonly addCodeBlock: (code: string, lang?: string) => ActionSummary
  readonly addList: (items: ReadonlyArray<string>, ordered?: boolean) => ActionSummary
  readonly addTable: (rows: ReadonlyArray<ReadonlyArray<SummaryTableCell>>) => ActionSummary
  readonly addDetails: (label: string, content: string) => ActionSummary
  readonly addImage: (src: string, alt: string, options?: SummaryImageOptions) => ActionSummary
  readonly addLink: (text: string, href: string) => ActionSummary
  readonly addSeparator: () => ActionSummary
  readonly addBreak: () => ActionSummary
  readonly addQuote: (text: string, cite?: string) => ActionSummary

  // Buffer methods
  readonly stringify: () => string
  readonly isEmptyBuffer: () => boolean
  readonly emptyBuffer: () => ActionSummary

  // File operations
  readonly write: (options?: { overwrite?: boolean }) => Effect.Effect<ActionSummary, ActionSummaryError>
  readonly clear: () => Effect.Effect<ActionSummary, ActionSummaryError>
}

Added in v1.0.0

SummaryImageOptions (interface)

Signature

export interface SummaryImageOptions {
  readonly width?: string
  readonly height?: string
}

Added in v1.0.0

SummaryTableCell (interface)

Signature

export interface SummaryTableCell {
  readonly data: string
  readonly header?: boolean
  readonly colspan?: number
  readonly rowspan?: number
}

Added in v1.0.0

SummaryTableRow (interface)

Signature

export interface SummaryTableRow {
  readonly [key: string]: SummaryTableCell
}

Added in v1.0.0

type id

TypeId

Signature

export declare const TypeId: typeof TypeId

Added in v1.0.0

TypeId (type alias)

Signature

export type TypeId = typeof TypeId

Added in v1.0.0