@leverege/build-tools 2.33.1 → 2.33.2-bruno.1

package/.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "eslint.alwaysShowStatus": true,
+  "[javascript]": {
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true,
+      "source.organizeImports": false
+    }
+  },
+  "[javascriptreact]": {
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true,
+      "source.organizeImports": false
+    }
+  },
+}

package/lib/server/tag-release.js

@@ -302,6 +302,19 @@ const getGitTagSuffix = async () => {
   });
   return tagSuffix;
 };
+const getGitAnnotationMessage = async ({
+  tagName
+}) => {
+  const {
+    annotationMessage
+  } = await prompt({
+    type: 'input',
+    name: 'annotationMessage',
+    message: 'What annotation message would you like to add to git tag?',
+    initial: tagName
+  });
+  return annotationMessage;
+};
 const confirmPushCommit = async buildMessage => {
   const {
     confirm
@@ -425,19 +438,19 @@ const commitAndPushNewBuild = async config => {
   await createNewBuildCommit(config);
   await pushToGitRemote();
 };
-const confirmPushTag = async tagName => {
+const confirmPushTag = async (tagName, annotationMessage) => {
   const {
     confirm
   } = await prompt([{
     type: 'confirm',
     name: 'confirm',
-    message: `${_ansiColors.default.bold.red('[Warning]')} Push new tag ${_ansiColors.default.bold.yellow(tagName)} to git remote?`
+    message: `${_ansiColors.default.bold.red('[Warning]')} Push new tag ${_ansiColors.default.bold.yellow(tagName)} with annotation message "${_ansiColors.default.bold.yellow(annotationMessage)}" to git remote?`
   }]);
   return confirm;
 };
-const createGitTag = async tagName => {
+const createGitTag = async (tagName, annotationMessage) => {
   try {
-    await (0, _zx.$)`git tag ${tagName}`;
+    await (0, _zx.$)`git tag -a ${tagName} -m "${annotationMessage}"`;
   } catch (err) {
     console.log(err.stderr || err);
     process.exit(1);
@@ -453,11 +466,12 @@ const pushGitTag = async tagName => {
 };
 const createAndPushGitTag = async ({
   tagName,
+  annotationMessage,
   noConfirm
 }) => {
-  const confirmAnswer = noConfirm || (await confirmPushTag(tagName));
+  const confirmAnswer = noConfirm || (await confirmPushTag(tagName, annotationMessage));
   if (confirmAnswer) {
-    await createGitTag(tagName);
+    await createGitTag(tagName, annotationMessage);
     await pushGitTag(tagName);
   }
 };
@@ -497,9 +511,11 @@ const displayReleaseInfo = config => {
     packagePath,
     buildMessage,
     tagName,
+    annotationMessage,
     publishable,
     npmjsTag,
-    isBetaRelease
+    isBetaRelease,
+    noGitTag
   } = config;
   console.log(`
 
@@ -509,8 +525,9 @@ ${_ansiColors.default.blue('Version:')} ${version}
 ${_ansiColors.default.blue('Root directory:')} ${repositoryRoot}
 ${_ansiColors.default.blue('Package name:')} ${packageName}
 ${_ansiColors.default.blue('package.json path:')} ${_path.default.join(packagePath, 'package.json')}${buildMessage ? `
-${_ansiColors.default.blue('Commit message:')} ${buildMessage}` : ''}${isBetaRelease ? '' : `
-${_ansiColors.default.blue('Git tag:')} ${tagName}`}${publishable ? `
+${_ansiColors.default.blue('Commit message:')} ${buildMessage}` : ''}${isBetaRelease || noGitTag ? '' : `
+${_ansiColors.default.blue('Git tag:')} ${tagName}`}${isBetaRelease || noGitTag ? '' : `
+${_ansiColors.default.blue('Git tag annotation:')} ${annotationMessage}`}${publishable ? `
 ${_ansiColors.default.blue('Npmjs tag:')} ${npmjsTag}` : ''}
 ${_ansiColors.default.bold.green('=============================================')}
 `);
@@ -551,6 +568,11 @@ const optionList = [{
   type: String,
   alias: 't',
   description: 'tag suffix to be appended to the version when pushing to git'
+}, {
+  name: 'annotation-message',
+  type: String,
+  alias: 'm',
+  description: 'annotation message that will annotate the git tag'
 }, {
   name: 'branch-filter',
   type: String,
@@ -560,6 +582,10 @@ const optionList = [{
   name: 'no-commit',
   type: Boolean,
   description: 'do not create a new commit on git (in case the goal is just tagging it)'
+}, {
+  name: 'no-git-tag',
+  type: Boolean,
+  description: 'do not create a new tag on git'
 }, {
   name: 'no-confirm',
   type: Boolean,
@@ -589,6 +615,7 @@ validateArgs(args);
 const config = {};
 config.noConfirm = !!args['no-confirm'];
 config.noCommit = !!args['no-commit'];
+config.noGitTag = !!args['no-git-tag'];
 config.repositoryRoot = await getGitRootDirectory();
 config.branch = args.branch || (await getBranch({
   branchFilter: args['branch-filter']
@@ -601,10 +628,12 @@ config.version = args.version || (await getVersion(config));
 config.packageName = await getPackageName(config);
 config.buildMessage = config.noCommit ? '' : getBuildMessage(config);
 config.isBetaRelease = config.version.includes('-beta.');
-if (!config.isBetaRelease) {
+if (!config.isBetaRelease && !config.noGitTag) {
   const tagSuffix = args['tag-suffix'] ?? (await getGitTagSuffix());
   const tagPrefix = config.isPackageInRepositoryRoot ? '' : `${config.packageName}/`;
   config.tagName = `${tagPrefix}v${config.version}${tagSuffix}`;
+  const annotationMessage = args['annotation-message'] ?? (await getGitAnnotationMessage(config));
+  config.annotationMessage = annotationMessage;
 }
 config.publishable = !!args.publishable;
 if (config.publishable) {
@@ -624,7 +653,7 @@ if (!config.noConfirm) {
 if (!config.noCommit) {
   await commitAndPushNewBuild(config);
 }
-if (!config.isBetaRelease) {
+if (!config.isBetaRelease && !config.noGitTag) {
   await createAndPushGitTag(config);
 }
 if (config.publishable) {

package/lib/web/tag-release.js

@@ -302,6 +302,19 @@ const getGitTagSuffix = async () => {
   });
   return tagSuffix;
 };
+const getGitAnnotationMessage = async ({
+  tagName
+}) => {
+  const {
+    annotationMessage
+  } = await prompt({
+    type: 'input',
+    name: 'annotationMessage',
+    message: 'What annotation message would you like to add to git tag?',
+    initial: tagName
+  });
+  return annotationMessage;
+};
 const confirmPushCommit = async buildMessage => {
   const {
     confirm
@@ -425,19 +438,19 @@ const commitAndPushNewBuild = async config => {
   await createNewBuildCommit(config);
   await pushToGitRemote();
 };
-const confirmPushTag = async tagName => {
+const confirmPushTag = async (tagName, annotationMessage) => {
   const {
     confirm
   } = await prompt([{
     type: 'confirm',
     name: 'confirm',
-    message: `${_ansiColors.default.bold.red('[Warning]')} Push new tag ${_ansiColors.default.bold.yellow(tagName)} to git remote?`
+    message: `${_ansiColors.default.bold.red('[Warning]')} Push new tag ${_ansiColors.default.bold.yellow(tagName)} with annotation message "${_ansiColors.default.bold.yellow(annotationMessage)}" to git remote?`
   }]);
   return confirm;
 };
-const createGitTag = async tagName => {
+const createGitTag = async (tagName, annotationMessage) => {
   try {
-    await (0, _zx.$)`git tag ${tagName}`;
+    await (0, _zx.$)`git tag -a ${tagName} -m "${annotationMessage}"`;
   } catch (err) {
     console.log(err.stderr || err);
     process.exit(1);
@@ -453,11 +466,12 @@ const pushGitTag = async tagName => {
 };
 const createAndPushGitTag = async ({
   tagName,
+  annotationMessage,
   noConfirm
 }) => {
-  const confirmAnswer = noConfirm || (await confirmPushTag(tagName));
+  const confirmAnswer = noConfirm || (await confirmPushTag(tagName, annotationMessage));
   if (confirmAnswer) {
-    await createGitTag(tagName);
+    await createGitTag(tagName, annotationMessage);
     await pushGitTag(tagName);
   }
 };
@@ -497,9 +511,11 @@ const displayReleaseInfo = config => {
     packagePath,
     buildMessage,
     tagName,
+    annotationMessage,
     publishable,
     npmjsTag,
-    isBetaRelease
+    isBetaRelease,
+    noGitTag
   } = config;
   console.log(`
 
@@ -509,8 +525,9 @@ ${_ansiColors.default.blue('Version:')} ${version}
 ${_ansiColors.default.blue('Root directory:')} ${repositoryRoot}
 ${_ansiColors.default.blue('Package name:')} ${packageName}
 ${_ansiColors.default.blue('package.json path:')} ${_path.default.join(packagePath, 'package.json')}${buildMessage ? `
-${_ansiColors.default.blue('Commit message:')} ${buildMessage}` : ''}${isBetaRelease ? '' : `
-${_ansiColors.default.blue('Git tag:')} ${tagName}`}${publishable ? `
+${_ansiColors.default.blue('Commit message:')} ${buildMessage}` : ''}${isBetaRelease || noGitTag ? '' : `
+${_ansiColors.default.blue('Git tag:')} ${tagName}`}${isBetaRelease || noGitTag ? '' : `
+${_ansiColors.default.blue('Git tag annotation:')} ${annotationMessage}`}${publishable ? `
 ${_ansiColors.default.blue('Npmjs tag:')} ${npmjsTag}` : ''}
 ${_ansiColors.default.bold.green('=============================================')}
 `);
@@ -551,6 +568,11 @@ const optionList = [{
   type: String,
   alias: 't',
   description: 'tag suffix to be appended to the version when pushing to git'
+}, {
+  name: 'annotation-message',
+  type: String,
+  alias: 'm',
+  description: 'annotation message that will annotate the git tag'
 }, {
   name: 'branch-filter',
   type: String,
@@ -560,6 +582,10 @@ const optionList = [{
   name: 'no-commit',
   type: Boolean,
   description: 'do not create a new commit on git (in case the goal is just tagging it)'
+}, {
+  name: 'no-git-tag',
+  type: Boolean,
+  description: 'do not create a new tag on git'
 }, {
   name: 'no-confirm',
   type: Boolean,
@@ -589,6 +615,7 @@ validateArgs(args);
 const config = {};
 config.noConfirm = !!args['no-confirm'];
 config.noCommit = !!args['no-commit'];
+config.noGitTag = !!args['no-git-tag'];
 config.repositoryRoot = await getGitRootDirectory();
 config.branch = args.branch || (await getBranch({
   branchFilter: args['branch-filter']
@@ -601,10 +628,12 @@ config.version = args.version || (await getVersion(config));
 config.packageName = await getPackageName(config);
 config.buildMessage = config.noCommit ? '' : getBuildMessage(config);
 config.isBetaRelease = config.version.includes('-beta.');
-if (!config.isBetaRelease) {
+if (!config.isBetaRelease && !config.noGitTag) {
   const tagSuffix = args['tag-suffix'] ?? (await getGitTagSuffix());
   const tagPrefix = config.isPackageInRepositoryRoot ? '' : `${config.packageName}/`;
   config.tagName = `${tagPrefix}v${config.version}${tagSuffix}`;
+  const annotationMessage = args['annotation-message'] ?? (await getGitAnnotationMessage(config));
+  config.annotationMessage = annotationMessage;
 }
 config.publishable = !!args.publishable;
 if (config.publishable) {
@@ -624,7 +653,7 @@ if (!config.noConfirm) {
 if (!config.noCommit) {
   await commitAndPushNewBuild(config);
 }
-if (!config.isBetaRelease) {
+if (!config.isBetaRelease && !config.noGitTag) {
   await createAndPushGitTag(config);
 }
 if (config.publishable) {

package/package.json

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

package/src/tag-release.mjs

@@ -288,6 +288,16 @@ const getGitTagSuffix = async () => {
   return tagSuffix
 }
 
+const getGitAnnotationMessage = async ( { tagName } ) => {
+  const { annotationMessage } = await prompt( {
+    type : 'input',
+    name : 'annotationMessage',
+    message : 'What annotation message would you like to add to git tag?',
+    initial : tagName
+  } )
+  return annotationMessage
+}
+
 const confirmPushCommit = async ( buildMessage ) => {
   const { confirm } = await prompt( [ {
     type : 'confirm',
@@ -406,18 +416,18 @@ const commitAndPushNewBuild = async ( config ) => {
   await pushToGitRemote()
 }
 
-const confirmPushTag = async ( tagName ) => {
+const confirmPushTag = async ( tagName, annotationMessage ) => {
   const { confirm } = await prompt( [ {
     type : 'confirm',
     name : 'confirm',
-    message : `${colors.bold.red( '[Warning]' )} Push new tag ${colors.bold.yellow( tagName )} to git remote?`
+    message : `${colors.bold.red( '[Warning]' )} Push new tag ${colors.bold.yellow( tagName )} with annotation message "${colors.bold.yellow( annotationMessage )}" to git remote?`
   } ] )
   return confirm
 }
 
-const createGitTag = async ( tagName ) => {
+const createGitTag = async ( tagName, annotationMessage ) => {
   try {
-    await $`git tag ${tagName}`
+    await $`git tag -a ${tagName} -m "${annotationMessage}"`
   } catch ( err ) {
     console.log( err.stderr || err )
     process.exit( 1 )
@@ -433,10 +443,10 @@ const pushGitTag = async ( tagName ) => {
   }
 }
 
-const createAndPushGitTag = async ( { tagName, noConfirm } ) => {
-  const confirmAnswer = noConfirm || await confirmPushTag( tagName )
+const createAndPushGitTag = async ( { tagName, annotationMessage, noConfirm } ) => {
+  const confirmAnswer = noConfirm || await confirmPushTag( tagName, annotationMessage )
   if ( confirmAnswer ) {
-    await createGitTag( tagName )
+    await createGitTag( tagName, annotationMessage )
     await pushGitTag( tagName )
   }
 }
@@ -474,9 +484,11 @@ const displayReleaseInfo = ( config ) => {
     packagePath,
     buildMessage,
     tagName,
+    annotationMessage,
     publishable,
     npmjsTag,
-    isBetaRelease
+    isBetaRelease,
+    noGitTag,
   } = config
 
   console.log( `
@@ -487,8 +499,9 @@ ${colors.blue( 'Version:' )} ${version}
 ${colors.blue( 'Root directory:' )} ${repositoryRoot}
 ${colors.blue( 'Package name:' )} ${packageName}
 ${colors.blue( 'package.json path:' )} ${path.join( packagePath, 'package.json' )}${buildMessage ? `
-${colors.blue( 'Commit message:' )} ${buildMessage}` : ''}${isBetaRelease ? '' : `
-${colors.blue( 'Git tag:' )} ${tagName}`}${publishable ? `
+${colors.blue( 'Commit message:' )} ${buildMessage}` : ''}${isBetaRelease || noGitTag ? '' : `
+${colors.blue( 'Git tag:' )} ${tagName}`}${isBetaRelease || noGitTag ? '' : `
+${colors.blue( 'Git tag annotation:' )} ${annotationMessage}`}${publishable ? `
 ${colors.blue( 'Npmjs tag:' )} ${npmjsTag}` : ''}
 ${colors.bold.green( '=============================================' )}
 ` )
@@ -536,6 +549,12 @@ const optionList = [
     alias : 't',
     description : 'tag suffix to be appended to the version when pushing to git',
   },
+  {
+    name : 'annotation-message',
+    type : String,
+    alias : 'm',
+    description : 'annotation message that will annotate the git tag',
+  },
   { 
     name : 'branch-filter',
     type : String,
@@ -547,6 +566,11 @@ const optionList = [
     type : Boolean,
     description : 'do not create a new commit on git (in case the goal is just tagging it)',
   },
+  {
+    name : 'no-git-tag',
+    type : Boolean,
+    description : 'do not create a new tag on git',
+  },
   { 
     name : 'no-confirm',
     type : Boolean,
@@ -586,6 +610,8 @@ config.noConfirm = !!args['no-confirm']
 
 config.noCommit = !!args['no-commit']
 
+config.noGitTag = !!args['no-git-tag']
+
 config.repositoryRoot = await getGitRootDirectory()
 
 config.branch = args.branch || await getBranch( { branchFilter : args['branch-filter'] } )
@@ -605,10 +631,13 @@ config.buildMessage = config.noCommit ? '' : getBuildMessage( config )
 
 config.isBetaRelease = config.version.includes( '-beta.' )
 
-if ( !config.isBetaRelease ) {
+if ( !config.isBetaRelease && !config.noGitTag ) {
   const tagSuffix = args['tag-suffix'] ?? await getGitTagSuffix()
   const tagPrefix = config.isPackageInRepositoryRoot ? '' : `${config.packageName}/`
   config.tagName = `${tagPrefix}v${config.version}${tagSuffix}`
+
+  const annotationMessage = args['annotation-message'] ?? await getGitAnnotationMessage( config )
+  config.annotationMessage = annotationMessage
 }
 
 config.publishable = !!args.publishable
@@ -627,7 +656,7 @@ if ( !config.noConfirm ) {
 }
 
 if ( !config.noCommit ) { await commitAndPushNewBuild( config ) }
-if ( !config.isBetaRelease ) { await createAndPushGitTag( config ) }
+if ( !config.isBetaRelease && !config.noGitTag ) { await createAndPushGitTag( config ) }
 if ( config.publishable ) { await publishToNpmjs( config ) }
 
 process.exit()