UNPKG

9.49 kBTypeScriptView Raw
1import * as t from "io-ts";
2declare const author: t.PartialC<{
3 /** The name of the author to make commits with */
4 name: t.StringC;
5 /** The email of the author to make commits with */
6 email: t.StringC;
7}>;
8export declare type AuthorInformation = t.TypeOf<typeof author>;
9declare const githubInformation: t.PartialC<{
10 /** The github api to interact with */
11 githubApi: t.StringC;
12 /** The github graphql api to interact with */
13 githubGraphqlApi: t.StringC;
14 /** The branch that is used as the base. defaults to master */
15 baseBranch: t.StringC;
16}>;
17export declare type GithubInformation = t.TypeOf<typeof githubInformation>;
18declare const repoInformation: t.PartialC<{
19 /** The repo of to publish, might be set in package manager file. */
20 repo: t.StringC;
21 /** The owner of the repo to publish, might be set in package manager file. */
22 owner: t.StringC;
23}>;
24export declare type RepoInformation = t.TypeOf<typeof repoInformation>;
25export declare type PluginConfig = [string, any] | string;
26declare const releaseCalculationOptions: t.PartialC<{
27 /** Instead of publishing every PR only publish when "release" label is present */
28 onlyPublishWithReleaseLabel: t.BooleanC;
29}>;
30export declare type ReleaseCalculationOptions = t.TypeOf<typeof releaseCalculationOptions>;
31declare const logOptions: t.PartialC<{
32 /** Show more logs */
33 verbose: t.UnionC<[t.BooleanC, t.TupleC<[t.BooleanC, t.BooleanC]>]>;
34}>;
35export declare type LogOptions = t.TypeOf<typeof logOptions>;
36declare const globalOptions: t.PartialC<{
37 /** Another auto configuration to extend */
38 extends: t.StringC;
39 /** Labels that power auto */
40 labels: t.ArrayC<t.IntersectionC<[t.PartialC<{
41 changelogTitle: t.StringC;
42 color: t.StringC;
43 description: t.StringC;
44 releaseType: t.UnionC<[t.LiteralC<"none">, t.LiteralC<"skip">, ...t.LiteralC<import("./release").VersionLabel>[]]>;
45 overwrite: t.BooleanC;
46 }>, t.TypeC<{
47 name: t.StringC;
48 }>]>>;
49 /** Branches to create pre-releases from */
50 prereleaseBranches: t.ArrayC<t.StringC>;
51 /** Configured auto plugins */
52 plugins: t.ArrayC<t.UnionC<[t.StringC, t.TupleC<[t.StringC, t.AnyC]>]>>;
53 /** Whether to prefix the version with a "v" */
54 noVersionPrefix: t.BooleanC;
55 /**
56 * Manage old version branches.
57 * Can be a true or a custom version branch prefix.
58 *
59 * @default 'version-'
60 */
61 versionBranches: t.UnionC<[t.BooleanC, t.StringC]>;
62 /** Options to pass to "auto comment" */
63 comment: t.PartialC<{
64 delete: t.BooleanC;
65 edit: t.BooleanC;
66 }>;
67 /** Options to pass to "auto changelog" */
68 changelog: t.PartialC<{
69 message: t.StringC;
70 }>;
71 /** Options to pass to "auto release" */
72 release: t.PartialC<{
73 prerelease: t.BooleanC;
74 }>;
75 /** Options to pass to "auto shipit" */
76 shipit: t.PartialC<{
77 onlyGraduateWithReleaseLabel: t.BooleanC;
78 }>;
79 /** Options to pass to "auto canary" */
80 canary: t.PartialC<{
81 force: t.BooleanC;
82 message: t.UnionC<[t.LiteralC<false>, t.StringC]>;
83 }>;
84 /** Options to pass to "auto next" */
85 next: t.PartialC<{
86 message: t.StringC;
87 }>;
88}>;
89export declare type GlobalOptions = t.TypeOf<typeof globalOptions>;
90export declare const autoRc: t.IntersectionC<[t.PartialC<{
91 /** Another auto configuration to extend */
92 extends: t.StringC;
93 /** Labels that power auto */
94 labels: t.ArrayC<t.IntersectionC<[t.PartialC<{
95 changelogTitle: t.StringC;
96 color: t.StringC;
97 description: t.StringC;
98 releaseType: t.UnionC<[t.LiteralC<"none">, t.LiteralC<"skip">, ...t.LiteralC<import("./release").VersionLabel>[]]>;
99 overwrite: t.BooleanC;
100 }>, t.TypeC<{
101 name: t.StringC;
102 }>]>>;
103 /** Branches to create pre-releases from */
104 prereleaseBranches: t.ArrayC<t.StringC>;
105 /** Configured auto plugins */
106 plugins: t.ArrayC<t.UnionC<[t.StringC, t.TupleC<[t.StringC, t.AnyC]>]>>;
107 /** Whether to prefix the version with a "v" */
108 noVersionPrefix: t.BooleanC;
109 /**
110 * Manage old version branches.
111 * Can be a true or a custom version branch prefix.
112 *
113 * @default 'version-'
114 */
115 versionBranches: t.UnionC<[t.BooleanC, t.StringC]>;
116 /** Options to pass to "auto comment" */
117 comment: t.PartialC<{
118 delete: t.BooleanC;
119 edit: t.BooleanC;
120 }>;
121 /** Options to pass to "auto changelog" */
122 changelog: t.PartialC<{
123 message: t.StringC;
124 }>;
125 /** Options to pass to "auto release" */
126 release: t.PartialC<{
127 prerelease: t.BooleanC;
128 }>;
129 /** Options to pass to "auto shipit" */
130 shipit: t.PartialC<{
131 onlyGraduateWithReleaseLabel: t.BooleanC;
132 }>;
133 /** Options to pass to "auto canary" */
134 canary: t.PartialC<{
135 force: t.BooleanC;
136 message: t.UnionC<[t.LiteralC<false>, t.StringC]>;
137 }>;
138 /** Options to pass to "auto next" */
139 next: t.PartialC<{
140 message: t.StringC;
141 }>;
142}>, t.IntersectionC<[t.PartialC<{
143 /** The repo of to publish, might be set in package manager file. */
144 repo: t.StringC;
145 /** The owner of the repo to publish, might be set in package manager file. */
146 owner: t.StringC;
147}>, t.PartialC<{
148 /** The github api to interact with */
149 githubApi: t.StringC;
150 /** The github graphql api to interact with */
151 githubGraphqlApi: t.StringC;
152 /** The branch that is used as the base. defaults to master */
153 baseBranch: t.StringC;
154}>, t.PartialC<{
155 /** The name of the author to make commits with */
156 name: t.StringC;
157 /** The email of the author to make commits with */
158 email: t.StringC;
159}>, t.PartialC<{
160 /** Instead of publishing every PR only publish when "release" label is present */
161 onlyPublishWithReleaseLabel: t.BooleanC;
162}>, t.PartialC<{
163 /** Show more logs */
164 verbose: t.UnionC<[t.BooleanC, t.TupleC<[t.BooleanC, t.BooleanC]>]>;
165}>]>]>;
166export declare type AutoRc = t.TypeOf<typeof autoRc>;
167export declare const loadedAutoRc: t.IntersectionC<[t.IntersectionC<[t.PartialC<{
168 /** Another auto configuration to extend */
169 extends: t.StringC;
170 /** Labels that power auto */
171 labels: t.ArrayC<t.IntersectionC<[t.PartialC<{
172 changelogTitle: t.StringC;
173 color: t.StringC;
174 description: t.StringC;
175 releaseType: t.UnionC<[t.LiteralC<"none">, t.LiteralC<"skip">, ...t.LiteralC<import("./release").VersionLabel>[]]>;
176 overwrite: t.BooleanC;
177 }>, t.TypeC<{
178 name: t.StringC;
179 }>]>>;
180 /** Branches to create pre-releases from */
181 prereleaseBranches: t.ArrayC<t.StringC>;
182 /** Configured auto plugins */
183 plugins: t.ArrayC<t.UnionC<[t.StringC, t.TupleC<[t.StringC, t.AnyC]>]>>;
184 /** Whether to prefix the version with a "v" */
185 noVersionPrefix: t.BooleanC;
186 /**
187 * Manage old version branches.
188 * Can be a true or a custom version branch prefix.
189 *
190 * @default 'version-'
191 */
192 versionBranches: t.UnionC<[t.BooleanC, t.StringC]>;
193 /** Options to pass to "auto comment" */
194 comment: t.PartialC<{
195 delete: t.BooleanC;
196 edit: t.BooleanC;
197 }>;
198 /** Options to pass to "auto changelog" */
199 changelog: t.PartialC<{
200 message: t.StringC;
201 }>;
202 /** Options to pass to "auto release" */
203 release: t.PartialC<{
204 prerelease: t.BooleanC;
205 }>;
206 /** Options to pass to "auto shipit" */
207 shipit: t.PartialC<{
208 onlyGraduateWithReleaseLabel: t.BooleanC;
209 }>;
210 /** Options to pass to "auto canary" */
211 canary: t.PartialC<{
212 force: t.BooleanC;
213 message: t.UnionC<[t.LiteralC<false>, t.StringC]>;
214 }>;
215 /** Options to pass to "auto next" */
216 next: t.PartialC<{
217 message: t.StringC;
218 }>;
219}>, t.IntersectionC<[t.PartialC<{
220 /** The repo of to publish, might be set in package manager file. */
221 repo: t.StringC;
222 /** The owner of the repo to publish, might be set in package manager file. */
223 owner: t.StringC;
224}>, t.PartialC<{
225 /** The github api to interact with */
226 githubApi: t.StringC;
227 /** The github graphql api to interact with */
228 githubGraphqlApi: t.StringC;
229 /** The branch that is used as the base. defaults to master */
230 baseBranch: t.StringC;
231}>, t.PartialC<{
232 /** The name of the author to make commits with */
233 name: t.StringC;
234 /** The email of the author to make commits with */
235 email: t.StringC;
236}>, t.PartialC<{
237 /** Instead of publishing every PR only publish when "release" label is present */
238 onlyPublishWithReleaseLabel: t.BooleanC;
239}>, t.PartialC<{
240 /** Show more logs */
241 verbose: t.UnionC<[t.BooleanC, t.TupleC<[t.BooleanC, t.BooleanC]>]>;
242}>]>]>, t.TypeC<{
243 /** Labels that power auto */
244 labels: t.ArrayC<t.IntersectionC<[t.PartialC<{
245 changelogTitle: t.StringC;
246 color: t.StringC;
247 description: t.StringC;
248 releaseType: t.UnionC<[t.LiteralC<"none">, t.LiteralC<"skip">, ...t.LiteralC<import("./release").VersionLabel>[]]>;
249 overwrite: t.BooleanC;
250 }>, t.TypeC<{
251 name: t.StringC;
252 }>]>>;
253 /** Branches to create pre-releases from */
254 prereleaseBranches: t.ArrayC<t.StringC>;
255 /** The branch that is used as the base. defaults to master */
256 baseBranch: t.StringC;
257}>]>;
258export declare type LoadedAutoRc = t.TypeOf<typeof loadedAutoRc>;
259export {};
260//# sourceMappingURL=types.d.ts.map
\No newline at end of file