UNPKG

2.04 kBTypeScriptView Raw
1interface IAuthorOptions {
2 name?: string;
3 email?: string;
4}
5export interface IRepoOptions {
6 owner?: string;
7 repo?: string;
8}
9export interface ILogOptions {
10 verbose?: boolean;
11 veryVerbose?: boolean;
12}
13export interface IInitOptions {
14 onlyLabels?: boolean;
15 dryRun?: boolean;
16}
17export interface ICreateLabelsOptions {
18 dryRun?: boolean;
19}
20export interface ILabelOptions {
21 pr?: number;
22}
23export interface IPRCheckOptions {
24 pr?: number;
25 url?: string;
26 skipReleaseLabels?: string[];
27 context?: string;
28 dryRun?: boolean;
29}
30export interface IPRStatusOptions {
31 sha?: string;
32 pr?: number;
33 url: string;
34 state: 'pending' | 'success' | 'error' | 'failure';
35 description: string;
36 context: string;
37 dryRun?: boolean;
38}
39export interface IVersionOptions {
40 skipReleaseLabels?: string[];
41 onlyPublishWithReleaseLabel?: boolean;
42}
43export interface IChangelogOptions extends IAuthorOptions {
44 noVersionPrefix?: boolean;
45 dryRun?: boolean;
46 from?: string;
47 to?: string;
48 message?: string;
49}
50export interface IReleaseOptions extends IAuthorOptions {
51 noVersionPrefix?: boolean;
52 dryRun?: boolean;
53 useVersion?: string;
54}
55export interface ICommentOptions {
56 message?: string;
57 pr?: number;
58 context?: string;
59 dryRun?: boolean;
60 delete?: boolean;
61}
62export declare type IPRBodyOptions = ICommentOptions;
63export interface IShipItOptions {
64 dryRun?: boolean;
65}
66export interface ICanaryOptions {
67 dryRun?: boolean;
68 pr?: number;
69 build?: number;
70 message?: string | 'false';
71}
72export declare type GlobalOptions = {
73 githubApi?: string;
74 baseBranch?: string;
75 githubGraphqlApi?: string;
76 plugins?: string[];
77} & IRepoOptions & ILogOptions;
78export declare type ApiOptions = GlobalOptions & (IInitOptions | ICreateLabelsOptions | ILabelOptions | IPRCheckOptions | IPRStatusOptions | ICommentOptions | IChangelogOptions | IPRBodyOptions | IReleaseOptions | IVersionOptions | ICanaryOptions | IShipItOptions);
79export {};