interface Annotation

Annotation attached to a check run for reporting issues.

Properties

path: string

File path relative to repository root.

startLine: number

Starting line number (1-indexed).

endLine: number

Ending line number (1-indexed).

level: "notice" | "warning" | "failure"

Severity level of the annotation.

message: string

Description of the issue.

optional
title: string

Title shown in the annotation.

optional
rawDetails: string

Raw details in markdown format.

Usage

import { type Annotation } from ".";