chore: add oss clearance readme file copy step

Author: r0b1n

automation/scripts/package.json

@@ -14,7 +14,7 @@
         "lint": "echo 'Lint disabled for now, please update package scripts'",
         "lint:enableme": "eslint . --ext .mjs",
         "root-script:commitlint": "commitlint",
-        "root-script:format-staged": "pretty-quick --staged --config \"./.prettierrc.cjs\" --pattern \"**/{src,script,typings,test,**}/**/*.{cjs,mjs,js,jsx,ts,tsx,scss,html,xml,md,json}\""
+        "root-script:format-staged": "pretty-quick --staged --config \"./.prettierrc.cjs\" --pattern \"**/{src,script,typings,test,**}/**/*.{cjs,mjs,js,jsx,ts,tsx,scss,xml,md,json}\""
     },
     "dependencies": {
         "@commitlint/cli": "^19.8.0",

automation/utils/src/changelog.ts

@@ -10,6 +10,30 @@ export async function updateChangelogsAndCreatePR(
     const releaseBranchName = `${releaseTag}-update-changelog`;
     const appName = info.marketplace.appName;
 
+    // Check if branch already exists on remote
+    try {
+        const { stdout: remoteOutput } = await exec(`git ls-remote --heads ${remoteName} ${releaseBranchName}`, {
+            stdio: "pipe"
+        });
+        if (remoteOutput.trim()) {
+            // Branch exists on remote, get its commit hash and rename it
+            const remoteCommitHash = remoteOutput.split("\t")[0].substring(0, 7); // Get short hash from remote output
+            const renamedBranchName = `${releaseBranchName}-${remoteCommitHash}`;
+
+            console.log(
+                `Branch '${releaseBranchName}' already exists on remote. Renaming it to '${renamedBranchName}'...`
+            );
+
+            // Create new branch on remote with the renamed name pointing to the same commit
+            await exec(`git push ${remoteName} ${remoteName}/${releaseBranchName}:refs/heads/${renamedBranchName}`);
+            // Delete the old branch on remote
+            await exec(`git push ${remoteName} --delete ${releaseBranchName}`);
+        }
+    } catch (error) {
+        // Branch doesn't exist on remote, continue with original name
+        console.log(`Using branch name '${releaseBranchName}'`);
+    }
+
     console.log(`Creating branch '${releaseBranchName}'...`);
     await exec(`git checkout -b ${releaseBranchName}`);
 

automation/utils/src/steps.ts

@@ -12,7 +12,7 @@ import { copyMpkFiles, getMpkPaths } from "./monorepo";
 import { createModuleMpkInDocker } from "./mpk";
 import { ModuleInfo, PackageInfo, WidgetInfo } from "./package-info";
 import { addFilesToPackageXml, PackageType } from "./package-xml";
-import { cp, ensureFileExists, exec, mkdir, popd, pushd, rm, unzip, zip, chmod } from "./shell";
+import { cp, ensureFileExists, exec, mkdir, popd, pushd, rm, unzip, zip, chmod, find } from "./shell";
 import chalk from "chalk";
 
 type Step<Info, Config> = (params: { info: Info; config: Config }) => Promise<void>;
@@ -194,6 +194,57 @@ export async function addWidgetsToMpk({ config }: ModuleStepParams): Promise<voi
     rm("-rf", target);
 }
 
+export async function addREADMEOSSToMpk({ config, info }: ModuleStepParams): Promise<void> {
+    logStep("Add READMEOSS to mpk");
+
+    // Check that READMEOSS file exists in package root and find it by name pattern
+    const packageRoot = config.paths.package;
+    const widgetName = info.mxpackage.name;
+    const version = info.version.format();
+
+    // We'll search for files matching the name and version, ignoring timestamp
+    const readmeossPattern = `*${widgetName}__${version}__READMEOSS_*.html`;
+
+    console.info(`Looking for READMEOSS file matching pattern: ${readmeossPattern}`);
+
+    // Find files matching the pattern in package root
+    const matchingFiles = find(packageRoot).filter(file => {
+        const fileName = parse(file).base;
+        // Check if filename contains the widget name, version, and READMEOSS
+        return fileName.includes(`${widgetName}__${version}__READMEOSS_`) && fileName.endsWith(".html");
+    });
+
+    if (matchingFiles.length === 0) {
+        console.warn(
+            `⚠️  READMEOSS file not found for ${widgetName} version ${version}. Expected pattern: ${readmeossPattern}`
+        );
+        console.warn(`   Skipping READMEOSS addition to mpk.`);
+        return;
+    }
+
+    const readmeossFile = matchingFiles[0];
+    console.info(`Found READMEOSS file: ${parse(readmeossFile).base}`);
+
+    const mpk = config.output.files.modulePackage;
+    const widgets = await getMpkPaths(config.dependencies);
+    const mpkEntry = parse(mpk);
+    const target = join(mpkEntry.dir, "tmp");
+
+    rm("-rf", target);
+
+    console.info("Unzip module mpk");
+    await unzip(mpk, target);
+    chmod("-R", "a+rw", target);
+
+    console.info(`Add READMEOSS file to ${mpkEntry.base}`);
+    // Copy the READMEOSS file to the target directory
+    cp(readmeossFile, target);
+
+    console.info("Create module zip archive");
+    await zip(target, mpk);
+    rm("-rf", target);
+}
+
 export async function moveModuleToDist({ info, config }: ModuleStepParams): Promise<void> {
     logStep("Move module to dist");
 

packages/modules/data-widgets/scripts/release.ts

@@ -11,7 +11,8 @@ import {
     removeDist,
     runModuleSteps,
     writeModuleVersion,
-    copyActionsFiles
+    copyActionsFiles,
+    addREADMEOSSToMpk
 } from "@mendix/automation-utils/steps";
 
 import { bundleXLSX } from "./steps/bundle-xlsx";
@@ -30,6 +31,7 @@ async function main(): Promise<void> {
             copyModuleLicense,
             createModuleMpk,
             addWidgetsToMpk,
+            addREADMEOSSToMpk,
             moveModuleToDist
         ]
     });