@security-alert/sarif-to-comment/lib/index.d.ts

post comment to GitHub issue/pull requests

export type CreatedOptions = {
    /**
     * The title of post content
     */
    title?: string;
    /**
     * issue url of pull request url
     */
    postingURL: string;
    sarifContent: string;
    sarifContentOwner: string;
    sarifContentRepo: string;
    sarifContentBranch: string;
    sarifContentSourceRoot?: string;
    token: string;
    dryRun?: boolean;
    ghActionAuthenticationMode?: boolean;
    ruleDetails?: boolean;
    suppressedResults?: boolean;
    simple?: boolean;
    severity?: readonly string[];
    failon?: any;
};
export type PostedCommentResult = {
    posted: true;
    commentUrl: string;
    shouldFail: boolean;
} | {
    posted: false;
    reason: string;
    shouldFail: boolean;
};
export declare function postComment(options: CreatedOptions): Promise<PostedCommentResult>;