@tangelo/tangelo-configuration-toolkit 1.24.1 → 1.24.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.24.1",
+  "version": "1.24.3",
   "engines": {
     "node": ">=14.0.0"
   },

package/src/cli.js

@@ -77,7 +77,10 @@ module.exports = function cli () {
         reset: {alias: 'r', desc: 'Reset repository to last commit', conflicts: ['i', 'c', 'u']},
         clone: {alias: 'c', desc: 'Clone a client repository and do basic setup', conflicts: ['i', 'r', 'u']},
         'update-repo': {alias: 'ur', desc: 'Update repository', conflicts: ['i', 'r', 'c']},
-        'update-submodule': {alias: 'us', desc: 'Update TDI submodule, optionally pass release branch (without "release/")', conflicts: ['i', 'r', 'c']},
+        'update-submodule': {alias: 'us', desc: 'Update TDI submodule, optionally pass release branch (without "release/")', conflicts: ['i', 'r', 'c'], type:"string",
+          // Running --us with no argument should default to true - defaulting to empty string throws a yargs error
+          coerce: (v => v || true)
+        },
         dates: {alias: 'd', desc: '[hidden] Use i.c.w. update-submodule, pass 2 dates in format yyyy-mm-dd', conflicts: ['i', 'r', 'c'], implies: 'update-submodule', requiresArg: true, array: true, hidden: !_devmode}
       },
       handler: require('./modules/git')

package/src/lib/get-tdi-branch.js

@@ -1,9 +1,9 @@
 const execGitCommand = require('./exec-git-command');
 const path           = require('path');
+const compareVersions = require('compare-versions');
 
 module.exports = function getTdiBranch(toBranchName) {
   const tdiPath = path.join(_paths.repo, _paths.tdi);
-  const tdiBranch = {};
 
   // Fetch all
   _info(`Fetch TDI submodule`);
@@ -22,17 +22,26 @@ module.exports = function getTdiBranch(toBranchName) {
   const releaseBranches = execGitCommand(`branch --all --contains ${_git.commitTdi.local().hash}`, tdiPath).match(/remotes\/origin\/release\/[^\s]+/gsm);
   if (!releaseBranches || releaseBranches.error) _error(`Could not retrieve TDI release branches`);
 
-  // Get the first possible branch; prefer release/5.1 over release/5.2:
-  releaseBranches.sort((a, b) => a > b ? 1 : -1);
+  // Create a sorted list of release branches with their versions:
+  const sortedBranches = releaseBranches
+  .map(branch => {
+    return {
+      name: branch.replace('remotes/origin/', ''),
+      version: branch.replace('remotes/origin/release/', '')
+    }
+  })
+  .sort((a, b) => compareVersions(a.version, b.version));
 
-  // Set branch name of firstBranch without 'remotes/origin/'
-  tdiBranch.name = releaseBranches[0].replace(/remotes\/origin\//g, '');
+  // Choose the first possible branch; prefer release/5.1 over release/5.2:
+  const tdiBranch = sortedBranches[0];
 
   // In case of branch switch set from.name to the old branch and name to the new branch
   if (toBranch) {
-    if (tdiBranch.name > toBranch) _error(`You cannot downgrade to a lower release branch with TCT.`);
-    tdiBranch.from = {name: tdiBranch.name};
+    const toVersion = toBranch?.replace('release/', '');
+    if (compareVersions.compare(tdiBranch.version, toVersion, '>')) _error(`You cannot downgrade to a lower release branch with TCT.`);
+    tdiBranch.from = {name: tdiBranch.name, version: tdiBranch.version};
     tdiBranch.name = toBranch;
+    tdiBranch.version = toVersion;
 
     const branchHash = execGitCommand(`rev-parse origin/${toBranch}`, tdiPath);
     const commonAncestorHash = execGitCommand(`merge-base ${_git.commitTdi.local().hash} ${branchHash}`, tdiPath);

package/src/modules/deploy/execute.js

@@ -164,7 +164,11 @@ async function combineTranslations(file, enc, cb) {
   const language = file.basename.match(/custom-UI-text(_.+?)?\.properties/)[1] ?? '';
 
   // Read matching tdi translation file
-  const tdiTranslationPath = `cmscustom/tdi/custom-UI-text/custom-UI-text${language}.properties`;
+  const tdiTranslationPath = path.join(
+    // Current working directory can be either repo root for delivery pack or config folder otherwise, so adjust path accordingly
+    file.cwd.split(path.sep).pop() == 'config' ? '' : 'config', 
+    `cmscustom/tdi/custom-UI-text/custom-UI-text${language}.properties`
+  );
   let tdiTranslations;
   try {
     tdiTranslations = await fs.readFile(tdiTranslationPath, enc);

package/src/modules/git/index.js

@@ -172,14 +172,14 @@ function updateRepo () {
  */
 function updateSubmodule({dates = [], updateSubmodule: releaseBranchName}) {
   const [dateCustomFrom, dateCustomTo] = dates;
-  const toBranchName = typeof releaseBranchName !== 'boolean' ? releaseBranchName : null;
+  const targetVersion = typeof releaseBranchName !== 'boolean' ? releaseBranchName : null;
 
   if (dateCustomFrom) _warn(`While testing the "TDI commits requiring migration" note that the submodule is not changed.`);
-  if (dateCustomFrom && !toBranchName) _error(`Specify a release branch for testing the migration, e.g. "--us 5.6".`);
+  if (dateCustomFrom && !targetVersion) _error(`Specify a release branch for testing the migration, e.g. "--us 5.6".`);
 
   // For testing the migrations (dates argument is specified); submodule pull, fetch, updates fail or result in switching to the release-branch; while we want to test the migration in the current submodule branch / symlink to TDI-project. Therefore all submodule actions should not be applied when the dates argument is specified. As the release of the current submodule cannot be determined you also need to specify the toBranchName so you can test the migrations you want.
-  const branch = !dateCustomFrom ? getTdiBranch(toBranchName) : {'name': `release/${toBranchName}`};
-  const branchUpgrade = branch.from ? branch.from.name < branch.name : false;
+  const branch = !dateCustomFrom ? getTdiBranch(targetVersion) : {'name': `release/${targetVersion}`, 'version': targetVersion};
+  const branchUpgrade = branch.from ? compare(branch.from.version, branch.version, '<') : false;
 
   if (branchUpgrade) _info(`Current branch '${branch.from.name}' will be updated to '${branch.name}'\nCommon ancestor will be used in selecting TDI commits requiring migration: ${_formatDate(branch.commonAncestor.date)}`);
   _info(`Branch ${branch.name} is ${branch.commitsBehind} commits behind.\n`);
@@ -203,8 +203,6 @@ function updateSubmodule({dates = [], updateSubmodule: releaseBranchName}) {
     const migrations = _modulesTdi.require('git/tdiCommitsRequiringMigration.js');
     const fromDate = dateCustomFrom ? new Date(dateCustomFrom) : branch.commonAncestor?.date ?? dateBeforeUpdate;
     const toDate = dateCustomTo ? new Date(dateCustomTo) : new Date();
-    const fromVersion = branch.from?.name?.replace('release/', '');
-    const toVersion = branch.name.replace('release/', '');
 
     _info(`TDI commits requiring migration between ${_formatDate(fromDate)} and ${_formatDate(toDate)}`);
     // Filter the migrations that should be applied/considered; Also display older releases migrations
@@ -214,11 +212,11 @@ function updateSubmodule({dates = [], updateSubmodule: releaseBranchName}) {
       
       if (branchUpgrade) {
         // For branch upgrades, include all migrations for versions newer than the current one, and include new migrations for the current version
-        const isTargetBranch = compare(r.release, toVersion, '<=') && compare(r.release, fromVersion, '>');
-        return isTargetBranch || (r.release === fromVersion && withinDateRange);
+        const isTargetBranch = compare(r.release, branch.version, '<=') && compare(r.release, branch.from.version, '>');
+        return isTargetBranch || (r.release === branch.from.version && withinDateRange);
       } else {
         // For non-branch upgrades, only include new migrations for the current branch
-        return r.release === toVersion && withinDateRange;
+        return r.release === branch.version && withinDateRange;
       }
     }));
 
@@ -227,7 +225,7 @@ function updateSubmodule({dates = [], updateSubmodule: releaseBranchName}) {
     migrationsFiltered
       .sort((a, b) => Date(a.releases[0].date) > Date(b.releases[0].date) ? 1 : -1)
       .forEach(m => {
-        const date = _formatDate(new Date(m.releases.filter(r => branch.name >= `release/${r.release}`)[0].date));
+        const date = _formatDate(new Date(m.releases.filter(r => compare(branch.version, r.release, '>='))[0].date));
         relevantMigrationCount += m.callback(date, relevantMigrationCount+1) === 1 ? 1 : 0;
       });