1- import assert from 'node:assert' ;
2- import { readFileSync , writeFileSync } from 'fs' ;
3- import path from 'path' ;
4- import { inc , lt } from 'semver' ;
5- import yargs from 'yargs' ;
6- import { hideBin } from 'yargs/helpers' ;
7-
8- import {
9- walk ,
10- getDistTagsForModules ,
11- getLernaModules ,
12- changeScopeInFile ,
13- setDependencyVersion ,
14- DistTags ,
15- LernaModule ,
16- } from './prepareRelease' ;
17-
18- function replacePackageScopes (
19- rootDir : string ,
20- lernaModules : LernaModule [ ] ,
21- targetScope : string ,
22- ) : number {
23- let filesChanged = 0 ;
24- // replace all @bitgo packages & source code with alternate SCOPE
25- const filePaths = [
26- ...walk ( path . join ( rootDir , 'modules' ) ) ,
27- ...walk ( path . join ( rootDir , 'webpack' ) ) ,
28- ] ;
29- const moduleNames = lernaModules . map ( ( { name } ) => name ) ;
30-
31- filePaths . forEach ( ( file ) => {
32- filesChanged += changeScopeInFile ( file , moduleNames , targetScope ) ;
33- } ) ;
34- return filesChanged ;
35- }
36-
37- // modules/bitgo is the only package we publish without an `@bitgo` prefix, so
38- // we must manually set one
39- function replaceBitGoPackageScope ( rootDir : string , targetScope : string ) : void {
40- const cwd = path . join ( rootDir , 'modules' , 'bitgo' ) ;
41- const json = JSON . parse (
42- readFileSync ( path . join ( cwd , 'package.json' ) , { encoding : 'utf-8' } ) ,
43- ) ;
44- json . name = `${ targetScope } ;
45- writeFileSync (
46- path . join ( cwd , 'package.json' ) ,
47- JSON . stringify ( json , null , 2 ) + '\n' ,
48- ) ;
49- }
50-
51- /**
52- * Read package.json for a module
53- * @param module The module to read package.json from
54- * @returns The parsed package.json content
55- */
56- function readModulePackageJson ( module : LernaModule ) : any {
57- return JSON . parse (
58- readFileSync ( path . join ( module . location , 'package.json' ) , {
59- encoding : 'utf-8' ,
60- } ) ,
61- ) ;
62- }
63-
64- /**
65- * Write package.json for a module
66- * @param module The module to write package.json to
67- * @param json The content to write
68- */
69- function writeModulePackageJson ( module : LernaModule , json : any ) : void {
70- writeFileSync (
71- path . join ( module . location , 'package.json' ) ,
72- JSON . stringify ( json , null , 2 ) + '\n' ,
73- ) ;
74- }
75-
761/**
77- * Increment the version for a single module based on the preid.
2+ * Usage:
3+ * # to prepare a stable release on the stable channel
4+ * npx tsx ./scripts/prepare-release.ts latest --scope @bitgo
785 *
79- * @param {String } preid - The prerelease identifier
80- * @param {LernaModule } module - The module to update
81- * @param {DistTags|undefined } tags - The dist tags for the module
82- * @param {LernaModule[] } allModules - All modules for dependency updates
83- * @returns {String|undefined } - The new version if set, undefined otherwise
6+ * # to prepare a beta release in the beta organization
7+ * npx tsx ./scripts/prepare-release.ts beta --scope @bitgo-beta
8+ *
9+ * # to skip uninitialized modules, set the UNINITIALIZED_MODULES env var
10+ * # if modules are not initialized and are not skipped, they will fail
11+ * UNINITIALIZED_MODULES=@bitgo/sdk-coin-flrp npx tsx ./scripts/prepare-release.ts latest --scope @bitgo
8412 */
85- function incrementVersionsForModuleLocation (
86- preid : string ,
87- module : LernaModule ,
88- tags : DistTags | undefined ,
89- allModules : LernaModule [ ] ,
90- ) : string | undefined {
91- const json = readModulePackageJson ( module ) ;
92-
93- let prevTag : string | undefined = undefined ;
94-
95- if ( tags ) {
96- if ( tags [ preid ] ) {
97- const version = tags [ preid ] . split ( '-' ) ;
98- const latest = tags ?. latest ?. split ( '-' ) ?? [ '0.0.0' ] ;
99- prevTag = lt ( version [ 0 ] , latest [ 0 ] )
100- ? `${ tags . latest } ${ preid }
101- : tags [ preid ] ;
102- } else {
103- prevTag = `${ tags . latest } ${ preid } ;
104- }
105- }
10613
107- if ( prevTag ) {
108- const next = inc ( prevTag , 'prerelease' , undefined , preid ) ;
109- assert (
110- typeof next === 'string' ,
111- `Failed to increment version for ${ json . name } ${ prevTag } ,
112- ) ;
113- console . log ( `Setting next version for ${ json . name } ${ next } ) ;
114- json . version = next ;
115- writeModulePackageJson ( module , json ) ;
116-
117- // since we're manually setting new versions, we must also reconcile all other lerna packages to use the 'next' version for this module
118- allModules . forEach ( ( otherModule ) => {
119- // skip it for the current version
120- if ( otherModule . location === module . location ) {
121- return ;
122- }
123-
124- // Use readModulePackageJson here instead of direct readFileSync
125- const otherJson = readModulePackageJson ( otherModule ) ;
126-
127- // Check if this module depends on the one we're updating
128- const otherJsonString = JSON . stringify ( otherJson ) ;
129- if ( otherJsonString . includes ( json . name ) ) {
130- setDependencyVersion ( otherJson , json . name , next ) ;
131- writeModulePackageJson ( otherModule , otherJson ) ;
132- }
133- } ) ;
134-
135- return next ;
136- }
137- return undefined ;
138- }
14+ import path from 'path' ;
15+ import yargs from 'yargs' ;
16+ import { hideBin } from 'yargs/helpers' ;
13917
140- /**
141- * increment the version based on the preid.
142- *
143- * @param {String } preid - The prerelease identifier
144- * @param {LernaModule[] } lernaModules - The modules to update
145- */
146- async function incrementVersions (
147- preid : string ,
148- lernaModules : LernaModule [ ] ,
149- ) : Promise < void > {
150- const distTags = await getDistTagsForModules ( lernaModules ) ;
18+ import { getLernaModules , validateReleaseTransformations } from './prepareRelease' ;
19+ import { replacePackageScopes } from './prepareRelease/mutateScope' ;
20+ import { incrementVersions } from './prepareRelease/incrementVersions' ;
15121
152- for ( const m of lernaModules ) {
153- try {
154- incrementVersionsForModuleLocation (
155- preid ,
156- m ,
157- distTags . get ( m ) ,
158- lernaModules ,
159- ) ;
160- } catch ( e ) {
161- // it's not necessarily a blocking error. Let lerna try and publish anyways
162- console . warn (
163- `Couldn't set next version for ${ m . name } ${ m . location } ,
164- e ,
165- ) ;
166- }
167- }
168- }
22+ export const uninitializedModules = process . env . UNINITIALIZED_MODULES
23+ ? process . env . UNINITIALIZED_MODULES . split ( ',' )
24+ : [ ] ;
16925
17026yargs ( hideBin ( process . argv ) )
17127 . command (
@@ -186,9 +42,7 @@ yargs(hideBin(process.argv))
18642 . option ( 'root-dir' , {
18743 type : 'string' ,
18844 description : 'Root directory of the repository' ,
189- default :
190- process . env . BITGO_PREPARE_RELEASE_ROOT_DIR ||
191- path . join ( __dirname , '..' ) ,
45+ default : process . env . BITGO_PREPARE_RELEASE_ROOT_DIR || path . join ( __dirname , '..' ) ,
19246 } ) ;
19347 } ,
19448 async ( argv ) => {
@@ -201,34 +55,19 @@ yargs(hideBin(process.argv))
20155 try {
20256 // Get lerna modules directly
20357 const lernaModules = await getLernaModules ( ) ;
204-
20558 // Replace package scopes
206- const filesChanged = replacePackageScopes (
207- rootDir ,
208- lernaModules ,
209- targetScope ,
210- ) ;
211-
212- // Replace BitGo package scope
213- replaceBitGoPackageScope ( rootDir , targetScope ) ;
214-
59+ await replacePackageScopes ( rootDir , lernaModules , targetScope ) ;
21560 // Increment versions
216- await incrementVersions ( preid , lernaModules ) ;
61+ await incrementVersions ( preid , lernaModules , uninitializedModules ) ;
62+ await validateReleaseTransformations ( lernaModules , preid , targetScope ) ;
21763
218- if ( filesChanged ) {
219- console . log ( `Successfully re-targeted ${ filesChanged } ) ;
220- process . exit ( 0 ) ;
221- } else {
222- console . error (
223- 'No files were changed, something must have gone wrong.' ,
224- ) ;
225- process . exit ( 1 ) ;
226- }
64+ console . log ( `Successfully re-targeted module scopes and versions.` ) ;
65+ process . exit ( 0 ) ;
22766 } catch ( error ) {
22867 console . error ( 'Error in prepare-release script:' , error ) ;
22968 process . exit ( 1 ) ;
23069 }
231- } ,
70+ }
23271 )
23372 . help ( )
23473 . alias ( 'help' , 'h' )
0 commit comments