@leverege/build-tools 2.105.3 → 2.106.0

package/.vscode/launch.json

@@ -68,6 +68,16 @@
       "runtimeExecutable": "node",
       "console": "integratedTerminal"
     },
+    {
+      "name": "hook-and-release pubsub-pulse",
+      "type": "node",
+      "request": "launch",
+      "program": "${workspaceFolder}/src/hook-and-release.mjs",
+      "args": [""],
+      "cwd": "/Users/john/Work/leverege/cicd/@srv/pubsub-pulse",
+      "runtimeExecutable": "node",
+      "console": "integratedTerminal"
+    },
     {
       "name": "ingestor in monorepo",
       "type": "node",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.105.3",
+  "version": "2.106.0",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -74,6 +74,10 @@
     "node": "^22.22 || >=24.15",
     "npm": ">=11.10"
   },
+  "docker": {
+    "node": "24.14.0-alpine3.23",
+    "npm": "11.12.0"
+  },
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
     "@kubernetes/client-node": "^1.4.0",
@@ -90,8 +94,8 @@
     "googleapis": "^173.0.0",
     "handlebars": "^4.7.9",
     "ignore": "^7.0.5",
-    "inquirer": "14.0.0",
-    "js-yaml": "^4.1.1",
+    "inquirer": "14.0.2",
+    "js-yaml": "^4.2.0",
     "jsdoc": "^4.0.5",
     "ms": "^2.1.3",
     "npm-registry-fetch": "^20.0.0",

package/src/Docker.mjs

@@ -7,6 +7,7 @@ import chalk from 'chalk'
 import handlebars from 'handlebars'
 
 import {
+  BUILD_TOOLS_DOCKER,
   errorExit,
   getCleanTag,
   getDateTimestamp,
@@ -19,14 +20,10 @@ import {
 
 const DIRNAME = path.dirname( url.fileURLToPath( import.meta.url ) )
 
-// TODO: This is a temporary band-aid while we assess the impact of the yarn
-// and/or CI pipeline transition. This will at least allow us to lock down the
-// specific versions of node/npm and facilitate testing via the env vars.
-//
 // See the latest docker images here => https://hub.docker.com/_/node
-//
-const dockerfileNodeVersion = process.env.DOCKER_BUILD_NODE_VERSION || '24.14.0-alpine3.23'
-const dockerfileNpmVersion = process.env.DOCKER_BUILD_NPM_VERSION || '11.12.0'
+// Versions are defined in package.json "docker" stanza; env vars allow per-build overrides.
+const dockerfileNodeVersion = process.env.DOCKER_BUILD_NODE_VERSION || BUILD_TOOLS_DOCKER.node
+const dockerfileNpmVersion = process.env.DOCKER_BUILD_NPM_VERSION || BUILD_TOOLS_DOCKER.npm
 
 // The contents of these variables were initially located in files that live in
 // the build-tools repository, but it just became simpler to pull the contents

package/src/Utils.mjs

@@ -17,6 +17,14 @@ import YAML from 'js-yaml'
 // this assumes this file lives in the src dir of the build-tools repo
 export const BUILD_TOOLS_ROOT = process.env.BUILD_TOOLS_ROOT || path.dirname( url.fileURLToPath( import.meta.url ) )
 
+// load the package.json to get the docker image and minimum node version - we use this
+// in multiple places so good to centralize here
+// eslint-disable-next-line security/detect-non-literal-fs-filename
+const btPkg = JSON.parse( fs.readFileSync( path.join( BUILD_TOOLS_ROOT, '../package.json' ), 'utf8' ) )
+export const BUILD_TOOLS_DOCKER = btPkg.docker
+export const BUILD_TOOLS_MIN_NODE = semver.minVersion( btPkg.engines?.node ?? '22.0.0' )?.version ?? '22.0.0'
+export const BUILD_TOOLS_MIN_NPM = semver.minVersion( btPkg.engines?.npm ?? '11.10.0' )?.version ?? '11.10.0'
+
 let debugEnabled = process.env.BUILD_TOOLS_DEBUG === '1'
 
 export const enableDebug = () => { debugEnabled = true }
@@ -625,7 +633,10 @@ export const getRepositoryDescr = async () => {
   const gitRoot = await getGitRootDirectory()
   const gitHooksPath = await getGitHooksPath()
   const { branch : gitBranch, upstream : gitUpstream } = await getGitBranchAndUpstream()
-  const subPkgs = await glob( `${gitRoot}/{apps,packages}/*/**/package.json`, { ignore : '/**/node_modules/**' } )
+  const subPkgs = await glob(
+    `${gitRoot}/{apps,packages}/*/**/{package.json,pyproject.toml}`,
+    { ignore : [ '/**/node_modules/**', '/**/.venv/**' ] }
+  )
   const helmChart = await parseHelmChart()
   const rootPackageJson = await parseJsonFile( `${gitRoot}/package.json` )
   const rootPyProjectToml = await parsePyProjectToml( `${gitRoot}/pyproject.toml` )

package/src/chart-compass.mjs

@@ -11,6 +11,7 @@ import { lt as semverLt } from 'semver'
 import YAML from 'js-yaml'
 
 import {
+  BUILD_TOOLS_MIN_NODE,
   BUILD_TOOLS_ROOT,
   debug,
   errorExit,
@@ -77,9 +78,8 @@ if ( args._unknown ) {
 }
 /* eslint-enable no-underscore-dangle */
 
-const minNodejsVersion = '22.13.0'
-if ( semverLt( process.version, minNodejsVersion ) ) {
-  warning( `suggest upgrading to at least node ${minNodejsVersion}\n` )
+if ( semverLt( process.version, BUILD_TOOLS_MIN_NODE ) ) {
+  warning( `suggest upgrading to at least node ${BUILD_TOOLS_MIN_NODE}\n` )
 }
 
 // First of all, fail if we are not in a git repository

package/src/chart-to-registry.mjs

@@ -1,15 +1,13 @@
 #!/usr/bin/env node
-/*
- * chart-to-registry will...
- */
+
 import { existsSync, rmSync } from 'node:fs'
 
 import chalk from 'chalk'
-import commandLineArgs from 'command-line-args'
-import commandLineUsage from 'command-line-usage'
+import { Command } from 'commander'
 import { lt as semverLt } from 'semver'
 
 import {
+  BUILD_TOOLS_MIN_NODE,
   debug,
   errorExit,
   establishOauthAccess,
@@ -20,105 +18,44 @@ import {
   warning,
 } from './Utils.mjs'
 
-const commandLineOptions = [ // Use commandLineOptions to tie into the Usage statements
-  {
-    name : 'chart',
-    type : String,
-    defaultValue : 'helm',
-    description : '{green directory containing the chart - default: helm}',
-  },
-  {
-    name : 'location',
-    type : String,
-    description : '{green the location of the artifact registry the chart will be pushed to (default us-docker.pkg.dev)}',
-  },
-  {
-    name : 'project',
-    type : String,
-    description : '{green the name of the google project containing the npmrc and slack config secrets (default leverege-registry)}',
-  },
-  {
-    name : 'repository',
-    type : String,
-    description : '{green the target repository to receive the pushed chart}',
-  },
-  {
-    name : 'auth-only',
-    type : Boolean,
-    description : '{green update artifact registry auth token and exit}',
-  },
-  {
-    name : 'ignore-appv',
-    type : Boolean,
-    description : '{green ignore the Char.yaml appVersion format}',
-  },
-  {
-    name : 'dry-run',
-    type : Boolean,
-    description : '{yellow perform everything except the actual chart push}',
-  },
-  {
-    name : 'force',
-    type : Boolean,
-    description : '{yellow push the chart even if it already exists in the registry}',
-  },
-  {
-    name : 'help',
-    type : Boolean,
-    description : '{green display this help screen}',
-  },
-]
-
-const sections = [
-  {
-    header : 'Leverege Helm Chart to Artifact Registry',
-    content : `{green This tool is responsible for pushing a helm chart to its designated GCP
-Artifact Registry repository.}`
-  },
-  { header : 'Options',
-    optionList : commandLineOptions,
-  },
-]
-
-const args = commandLineArgs( commandLineOptions, { camelCase : true, partial : true } )
-const usage = commandLineUsage( sections )
-
-if ( args.help ) {
-  log( usage )
-  process.exit( 0 )
-}
-
-/* eslint-disable no-underscore-dangle */
-if ( args._unknown ) {
-  log( usage )
-  log( `\nUnrecognized argument [${chalk.bold.red( args._unknown )}]\n` )
-  process.exit( 1 )
-}
-/* eslint-enable no-underscore-dangle */
-
-const minNodejsVersion = '22.0.0'
-if ( semverLt( process.version, minNodejsVersion ) ) {
-  errorExit( `\n***ERROR: must be running at least node ${minNodejsVersion}\n` )
+const program = new Command()
+
+program
+  .configureHelp( { styleOptionTerm : str => chalk.bold.white( str ) } )
+  .description( chalk.green( 'Pushes a helm chart to its designated GCP Artifact Registry repository.' ) )
+  .option( '--chart <directory>', chalk.green( 'directory containing the chart' ), 'helm' )
+  .option( '--location <location>', chalk.green( 'location of the artifact registry (default: from values.yaml)' ) )
+  .option( '--project <project>', chalk.green( 'GCP project containing the registry (default: from values.yaml)' ) )
+  .option( '--repository <repository>', chalk.green( 'target repository to receive the pushed chart' ) )
+  .option( '--auth-only', chalk.green( 'update artifact registry auth token and exit' ) )
+  .option( '--ignore-appv', chalk.green( 'ignore the Chart.yaml appVersion format check' ) )
+  .option( '--refresh-deps', chalk.green( 'force a helm dependency update before pushing' ) )
+  .option( '--dry-run', chalk.yellow( 'perform everything except the actual chart push' ) )
+  .option( '--force', chalk.yellow( 'push the chart even if it already exists in the registry' ) )
+
+program.parse( process.argv )
+const opts = program.opts()
+
+if ( semverLt( process.version, BUILD_TOOLS_MIN_NODE ) ) {
+  errorExit( `\n***ERROR: must be running at least node ${BUILD_TOOLS_MIN_NODE}\n` )
 }
 
 // load up all we need to know about the chart
-const helmChart = await parseHelmChart( args.chart )
+const helmChart = await parseHelmChart( opts.chart )
 
-if ( !helmChart.chartAppVersion.startsWith( 'v' ) && !args.ignoreAppv ) {
+if ( !helmChart.chartAppVersion.startsWith( 'v' ) && !opts.ignoreAppv ) {
   warning( 'Chart.yaml appVersion does not begin with the letter "v"\n' )
   await proceed( 'You sure about this?' )
 }
 
-// helm push helm-package.tgz oci://REGISTRY_LOCATION/REGISTRY_PROJECT/REGISTRY_REPOSITORY/charts
-//
-const registryLocation = args.location || helmChart.registryLocation
-const registryProject = args.project || helmChart.registryProject
-const registryRepository = args.repository || helmChart.registryRepository
+const registryLocation = opts.location || helmChart.registryLocation
+const registryProject = opts.project || helmChart.registryProject
+const registryRepository = opts.repository || helmChart.registryRepository
 
 // deal with oauth token shenanigans
 const oauthResults = await establishOauthAccess( registryLocation )
 debug( { oauthResults, registryLocation }, '<===OAuth Login' )
-if ( args.authOnly ) {
+if ( opts.authOnly ) {
   process.exit( 0 )
 }
 
@@ -146,7 +83,7 @@ const {
 try {
   await shellCmd( `helm pull ${ociPushEndpoint}/${chartName} --version ${chartVersion}` )
   rmSync( chartPackage )
-  if ( args.force ) {
+  if ( opts.force ) {
     warning( `chart ${chartName} version ${chartVersion} exists - force pushing` )
   } else {
     errorExit( `\n***ERROR: chart ${chartName} version ${chartVersion} already exists` )
@@ -155,7 +92,7 @@ try {
   debug( `Chart ${chartName} version ${chartVersion} does not exist - proceeding` )
 }
 
-if ( depsOutOfSync ) {
+if ( depsOutOfSync || opts.refreshDeps ) {
   try {
     log( chalk.yellow.bold( '\nChart dependedencies are out of sync - updating...\n' ) )
     await shellCmd( 'helm dependency update ./helm', { stdio : 'inherit' } )
@@ -165,14 +102,14 @@ if ( depsOutOfSync ) {
 }
 
 try {
-  await shellCmd( `helm package ${args.chart}` )
+  await shellCmd( `helm package ${opts.chart}` )
   if ( !existsSync( chartPackage ) ) { // eslint-disable-line security/detect-non-literal-fs-filename
     errorExit( `\n***ERROR: expected helm package to produce ${chartPackage}` )
   }
 
   log( `\nPushing ${chalk.green.bold( chartPackage )} => ${chalk.green.bold( ociPushEndpoint )}` )
   const pushItRealGood = `helm push ${chartPackage} ${ociPushEndpoint}`
-  if ( !args.dryRun ) {
+  if ( !opts.dryRun ) {
     await shellCmd( pushItRealGood )
   } else {
     log( `\nDry run => ${chalk.green.bold( pushItRealGood )}` )

package/src/hook-and-release/Config.mjs

@@ -147,6 +147,7 @@ export default class Config {
     this.gitBranch = repoDescr.gitBranch
     this.gitHooksPath = repoDescr.gitHooksPath
     this.isMonoRepo = repoDescr.isMonoRepo
+    this.isYarnProject = repoDescr.isYarnProject
 
     const harHook = '.har'
     this.harDir = `${this.gitRoot}/${harHook}`
@@ -258,7 +259,7 @@ export default class Config {
 
       // for each script run sequentially
       for ( const script of scripts ) {
-        const cmd = `npm run ${script}`
+        const cmd = this.isYarnProject ? `yarn ${script}` : `npm run ${script}`
         log( `hook-and-release in ${chalk.green( runDirectory )} => ${chalk.green( cmd )}` )
         if ( !this.cliArgs.debug ) {
           try {

package/src/init-my-chart/init-my-chart.mjs

@@ -19,6 +19,7 @@ import { Chartwright } from './Chartwright.mjs'
 program
   .name( 'init-my-chart' )
   .description( 'Initialize a helm chart based on the latest Leverege leaf template' )
+  .option( '--preserve-old', 'Preserve existing helm chart by moving it to helm-old (instead of deleting it)' )
   .option( '--dry-run', 'Print output to console instead of generating the char' )
   .option( '--debug', 'Enable debug logging - use BUILD_TOOLS_DEBUG=1 for global' )
   .parse()
@@ -71,5 +72,10 @@ if ( options.dryRun ) {
 await chartwright.scribe( { Container, Chart, Values, ValuesText, Registry } )
 
 if ( movedOldHelm ) {
-  log( chalk.yellow( '\nAn existing helm chart was detected and moved to helm-old. Please review and migrate any customizations as needed.' ) )
+  if ( options.preserveOld ) {
+    log( chalk.yellow( '\nAn existing helm chart was detected and moved to helm-old. Please review and migrate any customizations as needed.' ) )
+  } else {
+    fs.rmSync( `${packageRoot}/helm-old`, { recursive : true, force : true } )
+    log( chalk.yellow( '\nAn existing helm chart was detected and removed to make way for the new chart structure.' ) )
+  }
 }

package/src/push-my-chart.mjs

@@ -1,8 +1,7 @@
 #!/usr/bin/env node
 
 import chalk from 'chalk'
-import commandLineArgs from 'command-line-args'
-import commandLineUsage from 'command-line-usage'
+import { Command } from 'commander'
 
 import {
   debug,
@@ -14,53 +13,27 @@ import {
   warning,
 } from './Utils.mjs'
 
-const commandLineOptions = [
-  {
-    name : 'chart',
-    type : String,
-    defaultValue : 'helm',
-    description : '{green directory containing the chart - default: helm}',
-  },
-  {
-    name : 'no-registry',
-    type : Boolean,
-    defaultValue : false,
-    description : '{green push to the museum but not the artifact registry}',
-  },
-  {
-    name : 'help',
-    type : Boolean,
-    description : '{green display this help screen}',
-  },
-]
+const program = new Command()
 
-const sections = [
-  {
-    header : 'Leverege Helm Chart Museum Pusher',
-    content : `{green This tool pushes Helm charts to both the legacy Chartmuseum (hosted on GCS)
+program
+  .configureHelp( { styleOptionTerm : str => chalk.bold.white( str ) } )
+  .description( chalk.green( `Pushes Helm charts to both the legacy Chartmuseum (hosted on GCS)
 and a Google Artifact Registry. It maintains compatibility with existing
 Chartmuseum users while enabling a seamless transition to Artifact Registry
-without disrupting current configurations.}`
-  },
-  { header : 'Options',
-    optionList : commandLineOptions,
-  },
-]
+without disrupting current configurations.` ) )
+  .option( '--chart <directory>', chalk.green( 'directory containing the chart' ), 'helm' )
+  .option( '--no-registry', chalk.green( 'push to the museum but not the artifact registry' ) )
+  .option( '--refresh-deps', chalk.green( 'force a helm dependency update before pushing' ) )
 
-const args = commandLineArgs( commandLineOptions, { camelCase : true, partial : true } )
-const usage = commandLineUsage( sections )
-
-if ( args.help ) {
-  log( usage )
-  process.exit( 0 )
-}
+program.parse( process.argv )
+const opts = program.opts()
 
 const {
   chartName,
   chartVersion,
   chartAppVersion,
   depsOutOfSync,
-} = await parseHelmChart( args.chart )
+} = await parseHelmChart( opts.chart )
 
 log( chalk.green( `Chart      => ${chalk.bold.yellow( chartName )}` ) )
 log( chalk.green( `Version    => ${chalk.bold.yellow( chartVersion )}` ) )
@@ -71,7 +44,7 @@ if ( !chartAppVersion.startsWith( 'v' ) ) {
   await proceed( 'You sure about this?' )
 }
 
-if ( depsOutOfSync ) {
+if ( depsOutOfSync || opts.refreshDeps ) {
   try {
     log( chalk.yellow.bold( '\nChart dependedencies are out of sync - updating...\n' ) )
     await shellCmd( 'helm dependency update ./helm', { stdio : 'inherit' } )
@@ -83,22 +56,21 @@ if ( depsOutOfSync ) {
 let museumStatus = 0
 try {
   log( chalk.green( '  ... pushing to the Museum' ) )
-  const museum = await shellCmd( `helm cm-push ${args.chart} leverege` )
+  const museum = await shellCmd( `helm cm-push ${opts.chart} leverege` )
   debug( { museum }, '<==output from helm push' )
 } catch ( ex ) {
-  // log( ex.stderr )
   log( ex.message )
   museumStatus = 1
 }
 
-if ( args.noRegistry ) {
+if ( !opts.registry ) {
   log( `${chalk.bold.yellow( '\nskipping the chart push to the artifact registry' )}` )
   process.exit( museumStatus )
 }
 
 try {
   log( chalk.green( '  ... pushing to the Artifact Registry' ) )
-  const registry = await shellCmd( `chart-to-registry --chart ${args.chart} --ignore-appv` )
+  const registry = await shellCmd( `chart-to-registry --chart ${opts.chart} --ignore-appv` )
   debug( { registry }, '<==chart-to-registry' )
   process.exit( museumStatus )
 } catch ( ex ) {

package/src/refresh-npm-token.mjs

@@ -24,10 +24,7 @@ import chalk from 'chalk'
 import { program } from 'commander'
 import ms from 'ms'
 
-import { debug, log, shellCmd, versionChecks } from './Utils.mjs'
-
-const MIN_NODE_VERSION = '22.0.0'
-const MIN_NPM_VERSION = '11.10.0'
+import { debug, log, shellCmd, versionChecks, BUILD_TOOLS_MIN_NODE, BUILD_TOOLS_MIN_NPM } from './Utils.mjs'
 
 const NPMRC_FILE = `${os.homedir()}/.npmrc`
 const YARNRC_FILE = `${os.homedir()}/.yarnrc.yml`
@@ -85,8 +82,8 @@ const opts = program.opts()
 const gcpProject = opts.project
 
 await versionChecks( {
-  node   : { min : MIN_NODE_VERSION },
-  npm    : { min : MIN_NPM_VERSION, hint : 'required for npmMinimalAgeGate support' },
+  node   : { min : BUILD_TOOLS_MIN_NODE },
+  npm    : { min : BUILD_TOOLS_MIN_NPM, hint : 'required for npmMinimalAgeGate support' },
   strict : opts.versionCheck,
 } )