1 | export interface IAuthorOptions {
|
2 | /** Author's name */
|
3 | name?: string;
|
4 | /** Author's email */
|
5 | email?: string;
|
6 | }
|
7 | export interface IRepoOptions {
|
8 | /** Github repo owner (user) */
|
9 | owner?: string;
|
10 | /** GitHub project to operate on */
|
11 | repo?: string;
|
12 | }
|
13 | export interface ILogOptions {
|
14 | /** Show more logs */
|
15 | verbose?: boolean | boolean[];
|
16 | }
|
17 | export interface IInitOptions {
|
18 | /** Only show prompts for creating labels */
|
19 | onlyLabels?: boolean;
|
20 | /** Do not actually do anything */
|
21 | dryRun?: boolean;
|
22 | }
|
23 | export interface ICreateLabelsOptions {
|
24 | /** Do not actually do anything */
|
25 | dryRun?: boolean;
|
26 | }
|
27 | export interface ILabelOptions {
|
28 | /** PR to get the labels for */
|
29 | pr?: number;
|
30 | }
|
31 | export interface IPRCheckOptions {
|
32 | /** PR to check the label for */
|
33 | pr?: number;
|
34 | /** URL to attach to the checkmark */
|
35 | url?: string;
|
36 | /** The context the check should be attached to */
|
37 | context?: string;
|
38 | /** Do not actually do anything */
|
39 | dryRun?: boolean;
|
40 | }
|
41 | export interface IPRStatusOptions {
|
42 | /** The commit to attach a check to */
|
43 | sha?: string;
|
44 | /** The pr to attach a check to */
|
45 | pr?: number;
|
46 | /** URL to attach to the checkmark */
|
47 | url: string;
|
48 | /** The state to set the checkmark to */
|
49 | state: 'pending' | 'success' | 'error' | 'failure';
|
50 | /** The description to attach to the checkmark */
|
51 | description: string;
|
52 | /** The context the check should be attached to */
|
53 | context: string;
|
54 | /** Do not actually do anything */
|
55 | dryRun?: boolean;
|
56 | }
|
57 | export interface IVersionOptions {
|
58 | /** Instead of publishing every PR only publish when "release" label is present */
|
59 | onlyPublishWithReleaseLabel?: boolean;
|
60 | /** Commit to start calculating the version from */
|
61 | from?: string;
|
62 | }
|
63 | export interface IChangelogOptions extends IAuthorOptions {
|
64 | /** Whether to prefix the version with a "v" */
|
65 | noVersionPrefix?: boolean;
|
66 | /** Do not actually do anything */
|
67 | dryRun?: boolean;
|
68 | /** Commit to start calculating the changelog from */
|
69 | from?: string;
|
70 | /** Commit to start calculating the changelog to */
|
71 | to?: string;
|
72 | /** The commit message to commit the changelog changes with */
|
73 | message?: string;
|
74 | }
|
75 | export interface IReleaseOptions extends IAuthorOptions {
|
76 | /** Whether to prefix the version with a "v" */
|
77 | noVersionPrefix?: boolean;
|
78 | /** Do not actually do anything */
|
79 | dryRun?: boolean;
|
80 | /** Commit to start calculating the release from */
|
81 | from?: string;
|
82 | /** Override the version to release */
|
83 | useVersion?: string;
|
84 | }
|
85 | export interface ICommentOptions {
|
86 | /** The message to use when commenting */
|
87 | message?: string;
|
88 | /** THe PR to comment on */
|
89 | pr?: number;
|
90 | /** The context the message should be attached to. Use to post multiple comments to a PR */
|
91 | context?: string;
|
92 | /** Do not actually do anything */
|
93 | dryRun?: boolean;
|
94 | /** Delete the previous comment */
|
95 | delete?: boolean;
|
96 | /** Instead of deleting/adding a new comment. Just edit the old one */
|
97 | edit?: boolean;
|
98 | }
|
99 | export declare type IPRBodyOptions = ICommentOptions;
|
100 | export interface IShipItOptions {
|
101 | /** Do not actually do anything */
|
102 | dryRun?: boolean;
|
103 | /**
|
104 | * Make auto publish prerelease versions when merging to master.
|
105 | * Only PRs merged with "release" label will generate a "latest" release.
|
106 | * Only use this flag if you do not want to maintain a prerelease branch,
|
107 | * and instead only want to use master.
|
108 | */
|
109 | onlyGraduateWithReleaseLabel?: boolean;
|
110 | }
|
111 | export interface ICanaryOptions {
|
112 | /** Do not actually do anything */
|
113 | dryRun?: boolean;
|
114 | /** THe PR to attach the canary to */
|
115 | pr?: number;
|
116 | /** The build to attach the canary to */
|
117 | build?: number;
|
118 | /** The message used when attaching the canary version to a PR */
|
119 | message?: string | 'false';
|
120 | }
|
121 | export interface INextOptions {
|
122 | /** Do not actually do anything */
|
123 | dryRun?: boolean;
|
124 | /** The message used when attaching the prerelease version to a PR */
|
125 | message?: string;
|
126 | }
|
127 | export declare type GlobalOptions = {
|
128 | /** The GitHub api to communicate with through octokit */
|
129 | githubApi?: string;
|
130 | /** The branch that is used as the base. defaults to master */
|
131 | baseBranch?: string;
|
132 | /** The GitHub graphql api to communicate with through octokit */
|
133 | githubGraphqlApi?: string;
|
134 | /** Plugins to initialize "auto" with */
|
135 | plugins?: string[];
|
136 | } & IRepoOptions & ILogOptions;
|
137 | export declare type ApiOptions = GlobalOptions & (IInitOptions | ICreateLabelsOptions | ILabelOptions | IPRCheckOptions | IPRStatusOptions | ICommentOptions | IChangelogOptions | IPRBodyOptions | IReleaseOptions | IVersionOptions | ICanaryOptions | IShipItOptions);
|
138 | //# sourceMappingURL=auto-args.d.ts.map |
\ | No newline at end of file |