ghakit
    Preparing search index...

    Interface AnnotationOptions

    Optional annotation parameters for workflow commands that support annotations.

    interface AnnotationOptions {
        col?: number;
        endColumn?: number;
        endLine?: number;
        file?: string;
        line?: number;
        title?: string;
    }
    Index

    Properties

    col? endColumn? endLine? file? line? title?

    Properties

    col?: number

    Starting column number of the annotation within the file.

    Named col (not column) to match GitHub's workflow command parameter name, which uses col for the start and endColumn for the end.

    endColumn?: number

    Ending column number of the annotation within the file.

    endLine?: number

    Ending line number of the annotation within the file.

    file?: string

    Path to the file associated with the annotation, relative to the repository root.

    line?: number

    Starting line number of the annotation within the file.

    title?: string

    Custom title displayed in the annotation header.

    Settings

    Member Visibility

    On This Page

    Properties