Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/actionify/config/deps/github.ts>coreActions.AnnotationProperties

Create and manage your GitHub workflows with TypeScript and Deno.
ifiokjr/actionify
Latest
interface coreActions.AnnotationProperties
import { type coreActions } from "https://deno.land/x/actionify@0.3.0/config/deps/github.ts";
const { AnnotationProperties } = coreActions;

Optional properties that can be sent with annotatation commands (notice, error, and warning) See: https://docs.github.com/en/rest/reference/checks#create-a-check-run for more information about annotations.

Properties

optional
title: string

A title for the annotation.

optional
file: string

The path of the file for which the annotation should be created.

optional
startLine: number

The start line for the annotation.

optional
endLine: number

The end line for the annotation. Defaults to startLine when startLine is provided.

optional
startColumn: number

The start column for the annotation. Cannot be sent when startLine and endLine are different values.

optional
endColumn: number

The start column for the annotation. Cannot be sent when startLine and endLine are different values. Defaults to startColumn when startColumn is provided.