/
index.ts
173 lines (153 loc) · 5.03 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import {OctokitAPIs, GitHub, GitHubTag} from './github';
import {ReleaseType} from './releasers';
import {ReleasePR} from './release-pr';
import {ChangelogSection} from './conventional-commits';
import {Checkpoint} from './util/checkpoint';
import {Changes} from 'code-suggester';
export {ReleaseCandidate, ReleasePR} from './release-pr';
export * as Errors from './errors';
// Used by GitHub: Factory and Constructor
interface GitHubOptions {
defaultBranch?: string;
fork?: boolean;
token?: string;
apiUrl?: string;
octokitAPIs?: OctokitAPIs;
}
// Used by GitHubRelease: Factory and Constructor
export interface GitHubReleaseOptions {
releaseLabel?: string;
draft?: boolean;
skipGithubRelease?: boolean;
}
// Used by ReleasePR: Factory and Constructor
export interface ReleasePROptions {
path?: string;
packageName?: string;
bumpMinorPreMajor?: boolean;
bumpPatchForMinorPreMajor?: boolean;
releaseAs?: string;
snapshot?: boolean;
monorepoTags?: boolean;
changelogSections?: ChangelogSection[];
changelogPath?: string;
// only for Ruby: TODO replace with generic bootstrap option
lastPackageVersion?: string;
// for Ruby: TODO refactor to find version.rb like Python finds version.py
// and then remove this property
versionFile?: string;
pullRequestTitlePattern?: string;
signoff?: string;
extraFiles?: string[];
}
// GitHub Constructor options
export interface GitHubConstructorOptions extends GitHubOptions {
owner: string;
repo: string;
}
// Used by GitHubRelease and ReleasePR Constructor
interface ReleaserConstructorOptions {
github: GitHub;
}
interface ManifestOptions {
configFile?: string;
manifestFile?: string;
signoff?: string;
}
export interface ManifestConstructorOptions
extends ReleaserConstructorOptions,
ManifestOptions {
checkpoint?: Checkpoint;
}
export interface ManifestFactoryOptions
extends GitHubFactoryOptions,
ManifestOptions {}
// allow list of releaser options used to build ReleasePR subclass instances
// and GitHubRelease instances for each package. Rejected items:
// 1. `monorepoTags` and `pullRequestTitlePattern` will never apply
// 2. `lastPackageVersion` and `versionFile` could be supported if/when ruby
// support in the manifest is made available. However, ideally they'd be
// factored out of the ruby ReleasePR prior to adding support here.
// 3. currently unsupported but possible future support:
// - `snapshot`
// - `label`
export type ManifestPackage = Pick<
ReleasePROptions & GitHubReleaseOptions,
| 'draft'
| 'packageName'
| 'bumpMinorPreMajor'
| 'bumpPatchForMinorPreMajor'
| 'releaseAs'
| 'changelogSections'
| 'changelogPath'
| 'skipGithubRelease'
> & {
// these items are not optional in the manifest context.
path: string;
releaseType: ReleaseType;
};
export interface ManifestPackageWithPRData {
config: ManifestPackage;
prData: {version: string; changes: Changes};
}
// ReleasePR Constructor options
export interface ReleasePRConstructorOptions
extends ReleasePROptions,
ReleaserConstructorOptions {
labels?: string[];
skipDependencyUpdates?: boolean;
latestTag?: GitHubTag;
}
// GitHubRelease Constructor options
export interface GitHubReleaseConstructorOptions
extends GitHubReleaseOptions,
ReleaserConstructorOptions {
releasePR: ReleasePR;
}
// Used by everyone, Factory only. Convenience to offer shorthand way of
// specifying the repo and owner. Implementation parses the repoUrl and passes
// the resulting {owner,repo} to the GitHub constructor
interface FactoryOptions {
repoUrl: string;
}
// GitHub factory/builder options
export interface GitHubFactoryOptions extends GitHubOptions, FactoryOptions {}
// ReleasePR and GitHubRelease Factory
interface ReleaserFactory {
releaseType?: ReleaseType;
}
// ReleasePR factory/builder options
export interface ReleasePRFactoryOptions
extends ReleasePROptions,
GitHubFactoryOptions,
ReleaserFactory {
label?: string;
latestTagName?: string;
latestTagSha?: string;
latestTagVersion?: string;
}
// GitHubRelease factory/builder options
export interface GitHubReleaseFactoryOptions
extends GitHubReleaseOptions,
ReleasePROptions,
ReleasePRFactoryOptions,
GitHubFactoryOptions {}
export {factory} from './factory';
export {getReleaserTypes, getReleasers} from './releasers';
export {GitHubRelease} from './github-release';
export {JavaYoshi} from './releasers/java-yoshi';
export {Ruby} from './releasers/ruby';
export {setLogger, Logger} from './util/logger';