@storm-software/git-tools 2.123.16 → 2.124.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/bin/{chunk-SWXHQXUT.cjs → chunk-AU5PZKTN.cjs} +2 -0
- package/bin/chunk-AU5PZKTN.cjs.map +1 -0
- package/bin/{chunk-G3JMIIRF.cjs → chunk-EHPPIARR.cjs} +12 -17
- package/bin/chunk-EHPPIARR.cjs.map +1 -0
- package/bin/{chunk-L64XVBGM.cjs → chunk-FH5OSXAJ.cjs} +2 -0
- package/bin/chunk-FH5OSXAJ.cjs.map +1 -0
- package/bin/{chunk-S5PS23TL.js → chunk-G3YPGVPS.js} +2 -0
- package/bin/chunk-G3YPGVPS.js.map +1 -0
- package/bin/{chunk-AMSZ7DVW.js → chunk-Q3DQKTOI.js} +2 -0
- package/bin/chunk-Q3DQKTOI.js.map +1 -0
- package/bin/{chunk-K3LWFM6S.js → chunk-VBJB46HW.js} +13 -17
- package/bin/chunk-VBJB46HW.js.map +1 -0
- package/bin/git.cjs +941 -1500
- package/bin/git.cjs.map +1 -0
- package/bin/git.js +887 -1447
- package/bin/git.js.map +1 -0
- package/bin/post-checkout.cjs +16 -14
- package/bin/post-checkout.cjs.map +1 -0
- package/bin/post-checkout.js +5 -3
- package/bin/post-checkout.js.map +1 -0
- package/bin/post-commit.cjs +16 -14
- package/bin/post-commit.cjs.map +1 -0
- package/bin/post-commit.js +5 -3
- package/bin/post-commit.js.map +1 -0
- package/bin/post-merge.cjs +16 -14
- package/bin/post-merge.cjs.map +1 -0
- package/bin/post-merge.js +5 -3
- package/bin/post-merge.js.map +1 -0
- package/bin/pre-commit.cjs +14 -12
- package/bin/pre-commit.cjs.map +1 -0
- package/bin/pre-commit.js +4 -2
- package/bin/pre-commit.js.map +1 -0
- package/bin/pre-install.cjs +13 -11
- package/bin/pre-install.cjs.map +1 -0
- package/bin/pre-install.js +4 -2
- package/bin/pre-install.js.map +1 -0
- package/bin/pre-push.cjs +21 -19
- package/bin/pre-push.cjs.map +1 -0
- package/bin/pre-push.js +5 -3
- package/bin/pre-push.js.map +1 -0
- package/bin/prepare.cjs +11 -9
- package/bin/prepare.cjs.map +1 -0
- package/bin/prepare.js +4 -2
- package/bin/prepare.js.map +1 -0
- package/bin/version-warning.cjs +9 -7
- package/bin/version-warning.cjs.map +1 -0
- package/bin/version-warning.js +4 -2
- package/bin/version-warning.js.map +1 -0
- package/dist/chunk-3GGWHKRP.js +3 -6
- package/dist/chunk-4VPJA7YJ.cjs +9 -9
- package/dist/chunk-5XU2KBM6.js +1 -3
- package/dist/chunk-F7OO6L26.cjs +11 -16
- package/dist/chunk-JCEVFJCA.js +4 -14
- package/dist/chunk-KZRVQ5RZ.js +3 -11
- package/dist/chunk-M4QURF2M.cjs +2454 -0
- package/dist/chunk-NY53WLGC.cjs +16 -23
- package/dist/chunk-RJCCG4TV.js +2420 -0
- package/dist/chunk-YBAE6I5L.cjs +3 -3
- package/dist/commit/minimal.cjs +11 -3
- package/dist/commit/minimal.js +3 -10
- package/dist/commit/monorepo.cjs +11 -3
- package/dist/commit/monorepo.d.cts +1 -0
- package/dist/commit/monorepo.d.ts +1 -0
- package/dist/commit/monorepo.js +4 -11
- package/dist/commitlint/minimal.cjs +4 -5
- package/dist/commitlint/minimal.js +3 -6
- package/dist/commitlint/monorepo.cjs +4 -5
- package/dist/commitlint/monorepo.js +3 -6
- package/dist/index.cjs +40 -14
- package/dist/index.d.cts +4 -3
- package/dist/index.d.ts +4 -3
- package/dist/index.js +5 -20
- package/dist/release/config.cjs +30 -6
- package/dist/release/config.d.cts +33 -243
- package/dist/release/config.d.ts +33 -243
- package/dist/release/config.js +5 -14
- package/dist/types.cjs +7 -3
- package/dist/types.d.cts +91 -94
- package/dist/types.d.ts +91 -94
- package/dist/types.js +1 -6
- package/package.json +12 -12
- package/dist/chunk-GOKUSEH3.cjs +0 -77
- package/dist/chunk-YCEUZFMU.js +0 -77
package/dist/release/config.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import * as conventional_changelog_storm_software_types_commit_types from 'conventional-changelog-storm-software/types/commit-types';
|
|
2
|
-
import { CommitScopesEnum } from '../types.js';
|
|
2
|
+
import { CommitScopesEnum, ReleaseGroupConfig, ReleaseConfig } from '../types.js';
|
|
3
|
+
import { StormWorkspaceConfig } from '@storm-software/config/types';
|
|
3
4
|
import '@nx/devkit';
|
|
4
|
-
import '@storm-software/config/types';
|
|
5
5
|
import 'conventional-changelog-storm-software/types/commitlint';
|
|
6
|
+
import 'nx/src/command-line/release/config/config';
|
|
6
7
|
import 'nx/src/config/nx-json';
|
|
7
8
|
|
|
8
9
|
declare const DEFAULT_CONVENTIONAL_COMMITS_CONFIG: {
|
|
@@ -193,251 +194,40 @@ declare const DEFAULT_CONVENTIONAL_COMMITS_CONFIG: {
|
|
|
193
194
|
};
|
|
194
195
|
};
|
|
195
196
|
};
|
|
197
|
+
declare const DEFAULT_RELEASE_TAG_PATTERN = "{projectName}@{version}";
|
|
196
198
|
declare const DEFAULT_RELEASE_GROUP_CONFIG: {
|
|
197
|
-
projectsRelationship:
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
renderOptions: {
|
|
207
|
-
authors: boolean;
|
|
208
|
-
commitReferences: boolean;
|
|
209
|
-
versionTitleDate: boolean;
|
|
199
|
+
readonly projectsRelationship: "independent";
|
|
200
|
+
readonly changelog: {
|
|
201
|
+
readonly createRelease: "github";
|
|
202
|
+
readonly entryWhenNoChanges: false;
|
|
203
|
+
readonly file: false;
|
|
204
|
+
readonly renderOptions: {
|
|
205
|
+
readonly authors: false;
|
|
206
|
+
readonly commitReferences: true;
|
|
207
|
+
readonly versionTitleDate: true;
|
|
210
208
|
};
|
|
211
209
|
};
|
|
212
|
-
version: {
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
specifierSource: string;
|
|
217
|
-
generator: string;
|
|
218
|
-
generatorOptions: {
|
|
219
|
-
currentVersionResolver: string;
|
|
220
|
-
specifierSource: string;
|
|
221
|
-
};
|
|
210
|
+
readonly version: {
|
|
211
|
+
readonly currentVersionResolver: "git-tag";
|
|
212
|
+
readonly specifierSource: "conventional-commits";
|
|
213
|
+
readonly groupPreVersionCommand: "pnpm build";
|
|
222
214
|
};
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
conventionalCommits: {
|
|
226
|
-
questions: {
|
|
227
|
-
readonly type: {
|
|
228
|
-
readonly type: "select";
|
|
229
|
-
readonly title: "Commit Type";
|
|
230
|
-
readonly description: "Select the commit type that best describes your changes";
|
|
231
|
-
readonly enum: conventional_changelog_storm_software_types_commit_types.CommitTypesEnum;
|
|
232
|
-
readonly defaultValue: "chore";
|
|
233
|
-
readonly maxLength: 20;
|
|
234
|
-
readonly minLength: 3;
|
|
235
|
-
};
|
|
236
|
-
readonly scope: {
|
|
237
|
-
readonly type: "select";
|
|
238
|
-
readonly title: "Commit Scope";
|
|
239
|
-
readonly description: "Select the project that's the most impacted by this change";
|
|
240
|
-
readonly enum: CommitScopesEnum;
|
|
241
|
-
readonly defaultValue: "monorepo";
|
|
242
|
-
readonly maxLength: 50;
|
|
243
|
-
readonly minLength: 1;
|
|
244
|
-
};
|
|
245
|
-
readonly subject: {
|
|
246
|
-
readonly type: "input";
|
|
247
|
-
readonly title: "Commit Subject";
|
|
248
|
-
readonly description: "Write a short, imperative tense description of the change";
|
|
249
|
-
readonly maxLength: 150;
|
|
250
|
-
readonly minLength: 3;
|
|
251
|
-
};
|
|
252
|
-
readonly body: {
|
|
253
|
-
readonly type: "input";
|
|
254
|
-
readonly title: "Commit Body";
|
|
255
|
-
readonly description: "Provide a longer description of the change";
|
|
256
|
-
readonly maxLength: 600;
|
|
257
|
-
};
|
|
258
|
-
readonly isBreaking: {
|
|
259
|
-
readonly type: "confirm";
|
|
260
|
-
readonly title: "Breaking Changes";
|
|
261
|
-
readonly description: "Are there any breaking changes as a result of this commit?";
|
|
262
|
-
readonly defaultValue: false;
|
|
263
|
-
};
|
|
264
|
-
readonly breakingBody: {
|
|
265
|
-
readonly type: "input";
|
|
266
|
-
readonly title: "Breaking Changes (Details)";
|
|
267
|
-
readonly description: "A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself";
|
|
268
|
-
readonly when: (answers: Record<string, any>) => boolean;
|
|
269
|
-
readonly maxLength: 600;
|
|
270
|
-
readonly minLength: 3;
|
|
271
|
-
};
|
|
272
|
-
readonly isIssueAffected: {
|
|
273
|
-
readonly type: "confirm";
|
|
274
|
-
readonly title: "Open Issue Affected";
|
|
275
|
-
readonly description: "Does this change impact any open issues?";
|
|
276
|
-
readonly defaultValue: false;
|
|
277
|
-
};
|
|
278
|
-
readonly issuesBody: {
|
|
279
|
-
readonly type: "input";
|
|
280
|
-
readonly title: "Open Issue Affected (Details)";
|
|
281
|
-
readonly description: "If issues are closed, the commit requires a body. Please enter a longer description of the commit itself";
|
|
282
|
-
readonly when: (answers: Record<string, any>) => boolean;
|
|
283
|
-
readonly maxLength: 600;
|
|
284
|
-
readonly minLength: 3;
|
|
285
|
-
};
|
|
286
|
-
};
|
|
287
|
-
types: {
|
|
288
|
-
readonly chore: {
|
|
289
|
-
readonly description: "Other changes that don't modify src or test files";
|
|
290
|
-
readonly title: "Chore";
|
|
291
|
-
readonly emoji: "⚙️ ";
|
|
292
|
-
readonly semverBump: "patch";
|
|
293
|
-
readonly changelog: {
|
|
294
|
-
readonly title: "Miscellaneous";
|
|
295
|
-
readonly hidden: false;
|
|
296
|
-
};
|
|
297
|
-
};
|
|
298
|
-
readonly fix: {
|
|
299
|
-
readonly description: "A change that resolves an issue previously identified with the package";
|
|
300
|
-
readonly title: "Bug Fix";
|
|
301
|
-
readonly emoji: "🪲 ";
|
|
302
|
-
readonly semverBump: "patch";
|
|
303
|
-
readonly changelog: {
|
|
304
|
-
readonly title: "Bug Fixes";
|
|
305
|
-
readonly hidden: false;
|
|
306
|
-
};
|
|
307
|
-
};
|
|
308
|
-
readonly feat: {
|
|
309
|
-
readonly description: "A change that adds a new feature to the package";
|
|
310
|
-
readonly title: "Feature";
|
|
311
|
-
readonly emoji: "🔑 ";
|
|
312
|
-
readonly semverBump: "minor";
|
|
313
|
-
readonly changelog: {
|
|
314
|
-
readonly title: "Features";
|
|
315
|
-
readonly hidden: false;
|
|
316
|
-
};
|
|
317
|
-
};
|
|
318
|
-
readonly ci: {
|
|
319
|
-
readonly description: "Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)";
|
|
320
|
-
readonly title: "Continuous Integration";
|
|
321
|
-
readonly emoji: "🧰 ";
|
|
322
|
-
readonly semverBump: "patch";
|
|
323
|
-
readonly changelog: {
|
|
324
|
-
readonly title: "Continuous Integration";
|
|
325
|
-
readonly hidden: false;
|
|
326
|
-
};
|
|
327
|
-
};
|
|
328
|
-
readonly refactor: {
|
|
329
|
-
readonly description: "A code change that neither fixes a bug nor adds a feature";
|
|
330
|
-
readonly title: "Code Refactoring";
|
|
331
|
-
readonly emoji: "🧪 ";
|
|
332
|
-
readonly semverBump: "patch";
|
|
333
|
-
readonly changelog: {
|
|
334
|
-
readonly title: "Source Code Improvements";
|
|
335
|
-
readonly hidden: false;
|
|
336
|
-
};
|
|
337
|
-
};
|
|
338
|
-
readonly style: {
|
|
339
|
-
readonly description: "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)";
|
|
340
|
-
readonly title: "Style Improvements";
|
|
341
|
-
readonly emoji: "💎 ";
|
|
342
|
-
readonly semverBump: "patch";
|
|
343
|
-
readonly changelog: {
|
|
344
|
-
readonly title: "Style Improvements";
|
|
345
|
-
readonly hidden: false;
|
|
346
|
-
};
|
|
347
|
-
};
|
|
348
|
-
readonly perf: {
|
|
349
|
-
readonly description: "A code change that improves performance";
|
|
350
|
-
readonly title: "Performance Improvement";
|
|
351
|
-
readonly emoji: "⏱️ ";
|
|
352
|
-
readonly semverBump: "patch";
|
|
353
|
-
readonly changelog: {
|
|
354
|
-
readonly title: "Performance Improvements";
|
|
355
|
-
readonly hidden: false;
|
|
356
|
-
};
|
|
357
|
-
};
|
|
358
|
-
readonly docs: {
|
|
359
|
-
readonly description: "A change that only includes documentation updates";
|
|
360
|
-
readonly title: "Documentation";
|
|
361
|
-
readonly emoji: "📜 ";
|
|
362
|
-
readonly semverBump: "none";
|
|
363
|
-
readonly changelog: {
|
|
364
|
-
readonly title: "Documentation";
|
|
365
|
-
readonly hidden: false;
|
|
366
|
-
};
|
|
367
|
-
};
|
|
368
|
-
readonly test: {
|
|
369
|
-
readonly description: "Adding missing tests or correcting existing tests";
|
|
370
|
-
readonly title: "Testing";
|
|
371
|
-
readonly emoji: "🚨 ";
|
|
372
|
-
readonly semverBump: "none";
|
|
373
|
-
readonly changelog: {
|
|
374
|
-
readonly title: "Testing";
|
|
375
|
-
readonly hidden: true;
|
|
376
|
-
};
|
|
377
|
-
};
|
|
378
|
-
readonly deps: {
|
|
379
|
-
readonly description: "Changes that add, update, or remove dependencies. This includes devDependencies and peerDependencies";
|
|
380
|
-
readonly title: "Dependencies";
|
|
381
|
-
readonly emoji: "📦 ";
|
|
382
|
-
readonly hidden: true;
|
|
383
|
-
readonly semverBump: "patch";
|
|
384
|
-
readonly changelog: {
|
|
385
|
-
readonly title: "Dependency Upgrades";
|
|
386
|
-
readonly hidden: false;
|
|
387
|
-
};
|
|
388
|
-
};
|
|
389
|
-
readonly build: {
|
|
390
|
-
readonly description: "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)";
|
|
391
|
-
readonly title: "Build";
|
|
392
|
-
readonly emoji: "🛠 ";
|
|
393
|
-
readonly hidden: true;
|
|
394
|
-
readonly semverBump: "none";
|
|
395
|
-
readonly changelog: {
|
|
396
|
-
readonly title: "Build";
|
|
397
|
-
readonly hidden: true;
|
|
398
|
-
};
|
|
399
|
-
};
|
|
400
|
-
readonly release: {
|
|
401
|
-
readonly description: "Publishing a commit containing a newly released version";
|
|
402
|
-
readonly title: "Publish Release";
|
|
403
|
-
readonly emoji: "🚀 ";
|
|
404
|
-
readonly hidden: true;
|
|
405
|
-
readonly semverBump: "none";
|
|
406
|
-
readonly changelog: {
|
|
407
|
-
readonly title: "Publish Release";
|
|
408
|
-
readonly hidden: true;
|
|
409
|
-
};
|
|
410
|
-
};
|
|
411
|
-
};
|
|
412
|
-
};
|
|
413
|
-
changelog: {
|
|
414
|
-
git: {
|
|
415
|
-
tag: boolean;
|
|
416
|
-
};
|
|
417
|
-
automaticFromRef: boolean;
|
|
418
|
-
workspaceChangelog: boolean;
|
|
419
|
-
projectChangelogs: {
|
|
420
|
-
createRelease: string;
|
|
421
|
-
entryWhenNoChanges: boolean;
|
|
422
|
-
file: string;
|
|
423
|
-
renderOptions: {
|
|
424
|
-
authors: boolean;
|
|
425
|
-
commitReferences: boolean;
|
|
426
|
-
versionTitleDate: boolean;
|
|
427
|
-
};
|
|
428
|
-
};
|
|
429
|
-
};
|
|
430
|
-
version: {
|
|
431
|
-
preVersionCommand: string;
|
|
432
|
-
useLegacyVersioning: boolean;
|
|
433
|
-
currentVersionResolver: string;
|
|
434
|
-
specifierSource: string;
|
|
435
|
-
generator: string;
|
|
436
|
-
generatorOptions: {
|
|
437
|
-
currentVersionResolver: string;
|
|
438
|
-
specifierSource: string;
|
|
439
|
-
};
|
|
215
|
+
readonly releaseTag: {
|
|
216
|
+
readonly pattern: "{projectName}@{version}";
|
|
440
217
|
};
|
|
441
218
|
};
|
|
219
|
+
declare const DEFAULT_JS_RELEASE_GROUP_CONFIG: ReleaseGroupConfig;
|
|
220
|
+
declare const DEFAULT_RUST_RELEASE_GROUP_CONFIG: ReleaseGroupConfig;
|
|
221
|
+
declare const DEFAULT_RELEASE_CONFIG: ReleaseConfig;
|
|
222
|
+
/**
|
|
223
|
+
* Get the release group configurations, applying defaults where necessary
|
|
224
|
+
*
|
|
225
|
+
* @param releaseConfig - The release configuration to use
|
|
226
|
+
* @param workspaceConfig - The workspace configuration to use
|
|
227
|
+
* @returns The release group configurations
|
|
228
|
+
*/
|
|
229
|
+
declare function getReleaseGroupConfig(releaseConfig: Partial<ReleaseConfig>, workspaceConfig: StormWorkspaceConfig): {
|
|
230
|
+
[k: string]: ReleaseGroupConfig;
|
|
231
|
+
};
|
|
442
232
|
|
|
443
|
-
export { DEFAULT_CONVENTIONAL_COMMITS_CONFIG, DEFAULT_RELEASE_CONFIG, DEFAULT_RELEASE_GROUP_CONFIG };
|
|
233
|
+
export { DEFAULT_CONVENTIONAL_COMMITS_CONFIG, DEFAULT_JS_RELEASE_GROUP_CONFIG, DEFAULT_RELEASE_CONFIG, DEFAULT_RELEASE_GROUP_CONFIG, DEFAULT_RELEASE_TAG_PATTERN, DEFAULT_RUST_RELEASE_GROUP_CONFIG, getReleaseGroupConfig };
|
package/dist/release/config.js
CHANGED
|
@@ -1,14 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
import "../chunk-JCEVFJCA.js";
|
|
7
|
-
import "../chunk-KZRVQ5RZ.js";
|
|
8
|
-
import "../chunk-5XU2KBM6.js";
|
|
9
|
-
import "../chunk-3GGWHKRP.js";
|
|
10
|
-
export {
|
|
11
|
-
DEFAULT_CONVENTIONAL_COMMITS_CONFIG,
|
|
12
|
-
DEFAULT_RELEASE_CONFIG,
|
|
13
|
-
DEFAULT_RELEASE_GROUP_CONFIG
|
|
14
|
-
};
|
|
1
|
+
export { DEFAULT_CONVENTIONAL_COMMITS_CONFIG, DEFAULT_JS_RELEASE_GROUP_CONFIG, DEFAULT_RELEASE_CONFIG, DEFAULT_RELEASE_GROUP_CONFIG, DEFAULT_RELEASE_TAG_PATTERN, DEFAULT_RUST_RELEASE_GROUP_CONFIG, getReleaseGroupConfig } from '../chunk-RJCCG4TV.js';
|
|
2
|
+
import '../chunk-JCEVFJCA.js';
|
|
3
|
+
import '../chunk-KZRVQ5RZ.js';
|
|
4
|
+
import '../chunk-5XU2KBM6.js';
|
|
5
|
+
import '../chunk-3GGWHKRP.js';
|
package/dist/types.cjs
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var chunkYBAE6I5L_cjs = require('./chunk-YBAE6I5L.cjs');
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
|
|
7
|
+
Object.defineProperty(exports, "DEFAULT_COMMIT_PROMPT_MESSAGES", {
|
|
8
|
+
enumerable: true,
|
|
9
|
+
get: function () { return chunkYBAE6I5L_cjs.DEFAULT_COMMIT_PROMPT_MESSAGES; }
|
|
10
|
+
});
|
package/dist/types.d.cts
CHANGED
|
@@ -2,7 +2,8 @@ import { ProjectGraph, ProjectsConfigurations } from '@nx/devkit';
|
|
|
2
2
|
import { Variant } from '@storm-software/config/types';
|
|
3
3
|
import { CommitEnumItemProps } from 'conventional-changelog-storm-software/types/commit-types';
|
|
4
4
|
import { RuleConfigSeverity } from 'conventional-changelog-storm-software/types/commitlint';
|
|
5
|
-
import {
|
|
5
|
+
import { NxReleaseConfig } from 'nx/src/command-line/release/config/config';
|
|
6
|
+
import { NxReleaseDockerConfiguration, NxReleaseVersionConfiguration, NxReleaseChangelogConfiguration, NxReleaseVersionPlansConfiguration, NxReleaseConfiguration } from 'nx/src/config/nx-json';
|
|
6
7
|
|
|
7
8
|
type DeepPartial<T> = T extends object ? {
|
|
8
9
|
[P in keyof T]?: DeepPartial<T[P]>;
|
|
@@ -72,7 +73,7 @@ interface CommitLintOutcome {
|
|
|
72
73
|
/** All warnings, per rule, for the commit */
|
|
73
74
|
warnings: CommitLintRuleOutcome[];
|
|
74
75
|
}
|
|
75
|
-
type
|
|
76
|
+
type ReleaseOptions = any & {
|
|
76
77
|
npm: boolean;
|
|
77
78
|
github: boolean;
|
|
78
79
|
githubOptions?: Record<string, unknown>;
|
|
@@ -111,124 +112,120 @@ interface ReadMeOptions {
|
|
|
111
112
|
clean: boolean;
|
|
112
113
|
prettier: boolean;
|
|
113
114
|
}
|
|
114
|
-
interface
|
|
115
|
+
interface ReleaseGroupConfig {
|
|
115
116
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
117
|
+
* Whether to version and release projects within the group independently, or together in lock step ("fixed").
|
|
118
|
+
* If not set on the group, this will be informed by the projectsRelationship config at the top level.
|
|
118
119
|
*/
|
|
119
|
-
|
|
120
|
+
projectsRelationship?: "fixed" | "independent";
|
|
120
121
|
/**
|
|
121
|
-
*
|
|
122
|
-
*
|
|
122
|
+
* Required list of one or more projects to include in the release group. Any single project can
|
|
123
|
+
* only be used in a maximum of one release group.
|
|
123
124
|
*/
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
projectsRelationship?: "fixed" | "independent";
|
|
131
|
-
/**
|
|
132
|
-
* Required list of one or more projects to include in the release group. Any single project can
|
|
133
|
-
* only be used in a maximum of one release group.
|
|
134
|
-
*/
|
|
135
|
-
projects: string[] | string;
|
|
136
|
-
/**
|
|
137
|
-
* Optionally override version configuration for this group.
|
|
138
|
-
*
|
|
139
|
-
* NOTE: git configuration is not supported at the group level, only the root/command level
|
|
140
|
-
*/
|
|
141
|
-
version?: NxReleaseVersionConfiguration;
|
|
125
|
+
projects: string[] | string;
|
|
126
|
+
/**
|
|
127
|
+
* Configure options to handle versioning docker projects for this group.
|
|
128
|
+
* Set to `true` to enable with default settings, or provide a configuration object for custom settings.
|
|
129
|
+
*/
|
|
130
|
+
docker?: (NxReleaseDockerConfiguration & {
|
|
142
131
|
/**
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* - true = enable project level changelogs using default configuration
|
|
149
|
-
* - false = explicitly disable project level changelogs
|
|
150
|
-
*
|
|
151
|
-
* NOTE: git configuration is not supported at the group level, only the root/command level
|
|
132
|
+
* A command to run after validation of nx release configuration, but before docker versioning begins.
|
|
133
|
+
* Used for preparing docker build artifacts. If --dry-run is passed, the command is still executed, but
|
|
134
|
+
* with the NX_DRY_RUN environment variable set to 'true'.
|
|
135
|
+
* It will run in addition to the global `preVersionCommand`
|
|
152
136
|
*/
|
|
153
|
-
|
|
137
|
+
groupPreVersionCommand?: string;
|
|
138
|
+
}) | true;
|
|
139
|
+
/**
|
|
140
|
+
* Optionally override version configuration for this group.
|
|
141
|
+
*
|
|
142
|
+
* NOTE: git configuration is not supported at the group level, only the root/command level
|
|
143
|
+
*/
|
|
144
|
+
version?: NxReleaseVersionConfiguration & {
|
|
154
145
|
/**
|
|
155
|
-
*
|
|
146
|
+
* A command to run after validation of nx release configuration, but before versioning begins.
|
|
147
|
+
* Used for preparing build artifacts. If --dry-run is passed, the command is still executed, but
|
|
148
|
+
* with the NX_DRY_RUN environment variable set to 'true'.
|
|
149
|
+
* It will run in addition to the global `preVersionCommand`
|
|
156
150
|
*/
|
|
157
|
-
|
|
158
|
-
}
|
|
151
|
+
groupPreVersionCommand?: string;
|
|
152
|
+
};
|
|
159
153
|
/**
|
|
160
|
-
*
|
|
154
|
+
* Project changelogs are disabled by default.
|
|
155
|
+
*
|
|
156
|
+
* Here you can optionally override project changelog configuration for this group.
|
|
157
|
+
* Notes about boolean values:
|
|
158
|
+
*
|
|
159
|
+
* - true = enable project level changelogs using default configuration
|
|
160
|
+
* - false = explicitly disable project level changelogs
|
|
161
161
|
*
|
|
162
|
-
*
|
|
163
|
-
* released together in lock step.
|
|
162
|
+
* NOTE: git configuration is not supported at the group level, only the root/command level
|
|
164
163
|
*/
|
|
165
|
-
|
|
166
|
-
|
|
164
|
+
changelog?: NxReleaseChangelogConfiguration | boolean;
|
|
165
|
+
/**
|
|
166
|
+
* Configuration for release tag generation and matching.
|
|
167
|
+
*/
|
|
168
|
+
releaseTag?: {
|
|
167
169
|
/**
|
|
168
|
-
*
|
|
170
|
+
* The pattern to use for release tags. Supports interpolating {version}, {projectName}, and {releaseGroupName}.
|
|
169
171
|
*/
|
|
170
|
-
|
|
172
|
+
pattern?: string;
|
|
171
173
|
/**
|
|
172
|
-
*
|
|
174
|
+
* By default, we will try and resolve the latest match for the releaseTagPattern from the current branch,
|
|
175
|
+
* falling back to all branches if no match is found on the current branch.
|
|
173
176
|
*
|
|
174
|
-
* - true
|
|
175
|
-
* - false
|
|
177
|
+
* - Setting this to true will cause us to ALWAYS check all branches for the latest match.
|
|
178
|
+
* - Setting it to false will cause us to ONLY check the current branch for the latest match.
|
|
179
|
+
* - Setting it to an array of strings will cause us to check all branches WHEN the current branch matches one of the strings in the array. Glob patterns are supported.
|
|
176
180
|
*/
|
|
177
|
-
|
|
181
|
+
checkAllBranchesWhen?: boolean | string[];
|
|
178
182
|
/**
|
|
179
|
-
*
|
|
183
|
+
* By default, we will use semver when searching through the tags to find the latest matching tag.
|
|
180
184
|
*
|
|
181
|
-
* - true
|
|
182
|
-
* - false
|
|
185
|
+
* - Setting this to true will cause us to use semver to match the version
|
|
186
|
+
* - Setting this to false will cause us to not use semver to match the version allowing for non-semver versions
|
|
183
187
|
*/
|
|
184
|
-
|
|
185
|
-
/**
|
|
186
|
-
* Whether or not to automatically look up the first commit for the workspace (or package, if versioning independently)
|
|
187
|
-
* and use that as the starting point for changelog generation. If this is not enabled, changelog generation will fail
|
|
188
|
-
* if there is no previous matching git tag to use as a starting point.
|
|
189
|
-
*/
|
|
190
|
-
automaticFromRef?: boolean;
|
|
191
|
-
};
|
|
192
|
-
/**
|
|
193
|
-
* If no version config is provided, we will assume that @nx/js:release-version
|
|
194
|
-
* is the desired generator implementation, allowing for terser config for the common case.
|
|
195
|
-
*/
|
|
196
|
-
version?: NxReleaseVersionConfiguration & {
|
|
188
|
+
requireSemver?: boolean;
|
|
197
189
|
/**
|
|
198
|
-
*
|
|
190
|
+
* Controls how docker versions are used relative to semver versions when creating git tags and changelog entries.
|
|
191
|
+
*
|
|
192
|
+
* - true: Use only the docker version
|
|
193
|
+
* - false: Use only the semver version
|
|
194
|
+
* - 'both': Create tags and changelog entries for both docker and semver versions
|
|
195
|
+
*
|
|
196
|
+
* By default, this is set to true when docker configuration is present, and false otherwise.
|
|
199
197
|
*/
|
|
200
|
-
|
|
198
|
+
preferDockerVersion?: boolean | "both";
|
|
201
199
|
/**
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
*
|
|
200
|
+
* When set to true and multiple tags match your configured pattern, the git tag matching logic will strictly prefer the tag which contain a semver preid which matches the one
|
|
201
|
+
* given to the nx release invocation.
|
|
202
|
+
*
|
|
203
|
+
* For example, let's say your pattern is "{projectName}@{version}" and you have the following tags for project "my-lib", which uses semver:
|
|
204
|
+
* - my-lib@1.2.4-beta.1
|
|
205
|
+
* - my-lib@1.2.4-alpha.1
|
|
206
|
+
* - my-lib@1.2.3
|
|
207
|
+
*
|
|
208
|
+
* If "strictPreid" is set to true and you run:
|
|
209
|
+
* - `nx release --preid beta`, the git tag "my-lib@1.2.4-beta.1" will be resolved.
|
|
210
|
+
* - `nx release --preid alpha`, the git tag "my-lib@1.2.4-alpha.1" will be resolved.
|
|
211
|
+
* - `nx release` (no preid), the git tag "my-lib@1.2.3" will be resolved.
|
|
212
|
+
*
|
|
213
|
+
* If "strictPreid" is set to false, the git tag "my-lib@1.2.4-beta.1" will always be resolved as the latest tag that matches the pattern,
|
|
214
|
+
* regardless of any preid which gets passed to nx release.
|
|
215
|
+
*
|
|
216
|
+
* NOTE: This feature was added in a minor version and is therefore set to false by default, but this may change in a future major version.
|
|
205
217
|
*/
|
|
206
|
-
|
|
218
|
+
strictPreid?: boolean;
|
|
207
219
|
};
|
|
208
220
|
/**
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
* It supports interpolating the version as {version} and (if releasing independently or forcing
|
|
213
|
-
* project level version control system releases) the project name as {projectName} within the string.
|
|
214
|
-
*
|
|
215
|
-
* The default releaseTagPattern for fixed/unified releases is: "v{version}"
|
|
216
|
-
* The default releaseTagPattern for independent releases at the project level is: "{projectName}@{version}"
|
|
221
|
+
* Enables using version plans as a specifier source for versioning and
|
|
222
|
+
* to determine changes for changelog generation.
|
|
217
223
|
*/
|
|
218
|
-
|
|
219
|
-
/**
|
|
220
|
-
* Enable and configure automatic git operations as part of the release
|
|
221
|
-
*/
|
|
222
|
-
git?: NxReleaseGitConfiguration;
|
|
223
|
-
conventionalCommits?: NxReleaseConventionalCommitsConfiguration;
|
|
224
|
+
versionPlans?: NxReleaseVersionPlansConfiguration | boolean;
|
|
224
225
|
}
|
|
225
|
-
type
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
type NxReleaseVersionConfig = NonNullable<NxReleaseConfig["version"]>;
|
|
229
|
-
type NxReleaseGitConfig = NonNullable<NxReleaseConfig["git"]>;
|
|
230
|
-
type NxReleaseChangelogConfig = NonNullable<NxReleaseConfig["changelog"]>;
|
|
231
|
-
type NxReleaseGroupConfig = NxReleaseGroupsConfig[string];
|
|
226
|
+
type ReleaseConfig = Omit<NxReleaseConfiguration, "groups" | "conventionalCommits"> & Required<Pick<NxReleaseConfig, "conventionalCommits">> & {
|
|
227
|
+
groups: Record<string, ReleaseGroupConfig>;
|
|
228
|
+
};
|
|
232
229
|
type NxReleaseRequiredGitConfig = Required<{
|
|
233
230
|
commit?: boolean | undefined;
|
|
234
231
|
commitMessage?: string | undefined;
|
|
@@ -239,4 +236,4 @@ type NxReleaseRequiredGitConfig = Required<{
|
|
|
239
236
|
tagArgs?: string | undefined;
|
|
240
237
|
}>;
|
|
241
238
|
|
|
242
|
-
export { type CommitLintCLIOptions, type CommitLintOutcome, type CommitLintRuleOutcome, type CommitPromptMessagesEnum, type CommitQuestionProps, type CommitScopeProps, type CommitScopesEnum, type CommitSettingsEnum, type CommitState, DEFAULT_COMMIT_PROMPT_MESSAGES, type DeepPartial, type DefaultCommitPromptMessagesKeys, type
|
|
239
|
+
export { type CommitLintCLIOptions, type CommitLintOutcome, type CommitLintRuleOutcome, type CommitPromptMessagesEnum, type CommitQuestionProps, type CommitScopeProps, type CommitScopesEnum, type CommitSettingsEnum, type CommitState, DEFAULT_COMMIT_PROMPT_MESSAGES, type DeepPartial, type DefaultCommitPromptMessagesKeys, type NxReleaseRequiredGitConfig, type ReadMeOptions, type ReleaseConfig, type ReleaseContext, type ReleaseGroupConfig, type ReleaseOptions };
|