blob: 8363cd9797e71bf8f70b161d2593240fecd68164 [file] [log] [blame]
import {RestEndpointMethodTypes} from '@octokit/rest';
interface ArgsBase {
token: string;
conclusion?: Conclusion;
status: Status;
actionURL?: string;
detailsURL?: string;
output?: Output;
annotations?: Annotations;
images?: Images;
actions?: Actions;
}
export interface ArgsCreate extends ArgsBase {
name: string;
}
export interface ArgsUpdate extends ArgsBase {
checkID: number;
}
export type Args = ArgsCreate | ArgsUpdate;
// ChecksCreateParamsOutputAnnotations[]
export type Annotations = NonNullable<
NonNullable<RestEndpointMethodTypes['checks']['create']['parameters']['output']>['annotations']
>;
// ChecksCreateParamsOutputImages[]
export type Images = NonNullable<
NonNullable<RestEndpointMethodTypes['checks']['create']['parameters']['output']>['images']
>;
// ChecksCreateParamsActions[]
export type Actions = NonNullable<RestEndpointMethodTypes['checks']['create']['parameters']['actions']>;
export type Output = {
summary: string;
text_description?: string;
};
export enum Conclusion {
Success = 'success',
Failure = 'failure',
Neutral = 'neutral',
Cancelled = 'cancelled',
TimedOut = 'timed_out',
ActionRequired = 'action_required',
}
export enum Status {
Queued = 'queued',
InProgress = 'in_progress',
Completed = 'completed',
}