@leverege/build-tools 2.48.0 → 2.48.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.48.0",
+  "version": "2.48.2",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {

package/src/Utils.mjs

@@ -125,7 +125,7 @@ export const getGitUpstream = async () => {
 
 export const gitRepoIsDirty = async () => {
   const cleanliness = await shellCmd( 'git status --porcelain' )
-  return cleanliness?.length
+  return cleanliness?.length > 0
 }
 
 export const parseJsonFile = async ( jsonFile ) => {
@@ -278,7 +278,7 @@ https://console.cloud.google.com/artifacts/browse/leverege-registry?project=leve
   }
 
   // DEPRECATED: old reference to ./dist should be ./build
-  const { build, clean, dockerize, } = packageJson.scripts
+  const { build, clean, dockerize, museum, } = packageJson.scripts
 
   if ( build.match( 'dist' ) || clean.match( 'dist' ) ) {
     const deprecationError = `
@@ -315,6 +315,24 @@ https://console.cloud.google.com/artifacts/browse/leverege-registry?project=leve
 
     deprecated( { deprecationError, deprecationInfo } )
   }
+
+  // DEPRECATED: old museum reference to push-my-chart instead of chart-to-registry
+  if ( museum.match( 'push-my-chart' ) ) {
+    const deprecationError = `
+
+  Update the npm museum script to use chart-to-registry instead of the deprecated
+  push-my-chart script. The new museum target is simply:
+    `
+    const deprecationInfo = `
+  "scripts": {
+    ...
+    ${chalk.green.bold( '"museum": "chart-to-registry",' )}
+    ...
+  },
+  `
+
+    deprecated( { deprecationError, deprecationInfo } )
+  }
   return { artifactRegistry, ...packageJson }
 }
 
@@ -323,13 +341,21 @@ export const parseHelmChart = async ( helmroot = './helm' ) => {
   if ( !existsSync( helmroot ) ) { return undefined }
   const chartFiles = readdirSync( helmroot, { encoding : 'utf8', recursive : true } )
   const chartYaml = YAML.load( readFileSync( `${helmroot}/Chart.yaml`, 'utf8' ) )
+  const chartPackage = `${chartYaml.name}-${chartYaml.version}.tgz`
   const valuesYaml = YAML.load( readFileSync( `${helmroot}/values.yaml`, 'utf8' ) )
+  const imageRegistry = valuesYaml.image?.registry
+  const registryComponents = imageRegistry.split( '/' )
   /* eslint-enable security/detect-non-literal-fs-filename */
   return ( {
+    chartPackage,
+    imageRegistry,
+    registryRegion : registryComponents[0],
+    registryProject : registryComponents[1],
+    registryRepository : registryComponents[2],
     files : chartFiles,
     yaml : {
       'Chart.yaml' : chartYaml,
-      'values.yaml' : valuesYaml
+      'values.yaml' : valuesYaml,
     }
   } )
 }

package/src/chart-compass.mjs

@@ -0,0 +1,81 @@
+#!/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 { lt as semverLt } from 'semver'
+
+import {
+  debug,
+  errorExit,
+  log,
+  getGitRootDirectory,
+  parsePackageJson,
+  parseHelmChart,
+  shellCmd } from './Utils.mjs'
+
+const commandLineOptions = [ // Use commandLineOptions to tie into the Usage statements
+  /* eslint-disable max-len */
+  {
+    name : 'location',
+    type : String,
+    defaultValue : 'us-docker.pkg.dev',
+    description : '{green the location of the artifact registry the chart will be pushed to (default us-docker.pkg.dev)}',
+  },
+  {
+    name : 'project',
+    type : String,
+    defaultValue : process.env.HELM_CHART_REGISTRY || 'leverege-registry',
+    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 : 'help',
+    type : Boolean,
+    description : '{green display this help screen}',
+  },
+  /* eslint-enable max-len */
+]
+
+const sections = [
+  {
+    header : 'Leverege Helm Chart Location Tool',
+    content : `{green A tool for locating helm charts in registries. It was created to allow
+the helmup.sh bash script to easily locate charts, which may be in the
+chart museum, La everge artifact-registry project or a 3rd party
+developer\'s artifact-registry.}`
+  },
+  { 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 = '18.0.0'
+if ( semverLt( process.version, minNodejsVersion ) ) {
+  errorExit( `\n***ERROR: must be running at least node ${minNodejsVersion}\n` )
+}
+

package/src/chart-to-registry.mjs

@@ -2,6 +2,7 @@
 /*
  * chart-to-registry will...
  */
+import { existsSync, rmSync } from 'node:fs'
 
 import chalk from 'chalk'
 import commandLineArgs from 'command-line-args'
@@ -9,7 +10,7 @@ import commandLineUsage from 'command-line-usage'
 import { lt as semverLt } from 'semver'
 
 import {
-  condir, debug,
+  debug,
   errorExit,
   log,
   getGitRootDirectory,
@@ -20,16 +21,16 @@ import {
 const commandLineOptions = [ // Use commandLineOptions to tie into the Usage statements
   /* eslint-disable max-len */
   {
-    name : 'project',
+    name : 'location',
     type : String,
-    defaultValue : process.env.HELM_CHART_REGISTRY || 'leverege-registry',
-    description : '{green the name of the google project containing the npmrc and slack config secrets (default leverege-registry)}',
+    defaultValue : 'us-docker.pkg.dev',
+    description : '{green the location of the artifact registry the chart will be pushed to (default us-docker.pkg.dev)}',
   },
   {
-    name : 'region',
+    name : 'project',
     type : String,
-    defaultValue : 'us-docker.pkg.dev',
-    description : '{green the region of the artifact registry the chart will be pushed to (default us-docker.pkg.dev)}',
+    defaultValue : process.env.HELM_CHART_REGISTRY || 'leverege-registry',
+    description : '{green the name of the google project containing the npmrc and slack config secrets (default leverege-registry)}',
   },
   {
     name : 'repository',
@@ -48,7 +49,7 @@ const sections = [
   {
     header : 'Leverege Helm Chart to Artifact Registry',
     content : `{green This tool helps ...
-... multi-line helm.}`
+... multi-line help.}`
   },
   { header : 'Options',
     optionList : commandLineOptions,
@@ -76,8 +77,6 @@ if ( semverLt( process.version, minNodejsVersion ) ) {
   errorExit( `\n***ERROR: must be running at least node ${minNodejsVersion}\n` )
 }
 
-log( { args }, chalk.yellow( '\n\n***WARNING: Under Construction' ) )
-
 // gcloud auth print-access-token | helm registry login -u oauth2accesstoken \
 // -p ${password} https://us-docker.pkg.dev
 //
@@ -86,7 +85,7 @@ try {
   const accessToken = await shellCmd( 'gcloud auth print-access-token' )
   const registryLoginCommand = `helm registry login -u oauth2accesstoken -p ${accessToken}`
 
-  const loginResult = await shellCmd( `${registryLoginCommand} https://${args.region}` ) // TODO: cmd line param
+  const loginResult = await shellCmd( `${registryLoginCommand} https://${args.location}` ) // TODO: cmd line param
   debug( { loginResult }, '<==registryLogin' )
 } catch ( error ) {
   errorExit( error )
@@ -116,7 +115,25 @@ try {
   errorExit( error )
 }
 
-condir( { packageJson, helmChart }, '<==Parsed package and chart' )
+debug( { packageJson, helmChart }, '<==Parsed package and chart' )
+
+// 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 ociPushEndpoint = `oci://${registryLocation}/${registryProject}/${registryRepository}/charts`
 
-// helm push chart-tarball oci://REGISTRY_NAME/REPOSITORY_NAME/charts/SERVICE
-// helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/redis
+try {
+  await shellCmd( 'helm package helm' )
+  const { chartPackage } = helmChart
+  if ( !existsSync( chartPackage ) ) { // eslint-disable-line security/detect-non-literal-fs-filename
+    errorExit( `Error: expected helm package to produce ${chartPackage}` )
+  }
+
+  log( `\nPushing ${chalk.green.bold( chartPackage )} => ${chalk.green.bold( ociPushEndpoint )}` )
+  await shellCmd( `helm push ${chartPackage} ${ociPushEndpoint}` )
+  rmSync( chartPackage )
+} catch ( err ) {
+  errorExit( err )
+}

package/src/docker-to-registry.mjs

@@ -18,7 +18,7 @@ import {
 
 import docker from './Docker.mjs'
 
-const minimumBuildToolsVersion = '2.48.0'
+const minimumBuildToolsVersion = '2.48.1'
 
 // refresh-npm-token does not throw so no need to try, but it emits in debug
 const refreshErr = await shellCmd( 'refresh-npm-token' )

package/src/dockreate.sh

@@ -10,7 +10,9 @@ fi
 . `build-tools --bashfun`
 cat<<DOCKREATE_DEPRECATED
 
-  `color y "***DOCKREATE is DEPRECATED - move to docker-to-registry***"`
+  `color r "***DOCKREATE is DEPRECATED - move to docker-to-registry***"`
+
+  For guidance on transitioning run `color g docker-to-registry guide-me`
 
 DOCKREATE_DEPRECATED
 sleep 3