chore: add removal of readmeos file (#1881)

Author: r0b1n

automation/utils/src/changelog.ts

@@ -1,6 +1,8 @@
 import { gh } from "./github";
 import { PublishedInfo } from "./package-info";
 import { exec, popd, pushd } from "./shell";
+import { findOssReadme } from "./oss-readme";
+import { join } from "path";
 
 export async function updateChangelogsAndCreatePR(
     info: PublishedInfo,
@@ -50,14 +52,22 @@ export async function updateChangelogsAndCreatePR(
     const { stdout: root } = await exec(`git rev-parse --show-toplevel`, { stdio: "pipe" });
     pushd(root.trim());
     await exec(`git add '*/CHANGELOG.md'`);
+
+    const path = process.cwd();
+    const readmeossFile = findOssReadme(path, info.mxpackage.name, info.version.format());
+    if (readmeossFile) {
+        console.log(`Removing OSS clearance readme file '${readmeossFile}'...`);
+        await exec(`git rm '${join(path, readmeossFile)}'`);
+    }
+
     await exec(`git commit -m "chore(${info.name}): update changelog"`);
     await exec(`git push ${remoteName} ${releaseBranchName}`);
     popd();
 
     console.log(`Creating pull request for '${releaseBranchName}'`);
     await gh.createGithubPRFrom({
         title: `${appName} v${info.version.format()}: Update changelog`,
-        body: "This is an automated PR that merges changelog update to master.",
+        body: "This is an automated PR that merges changelog update to main branch.",
         base: "main",
         head: releaseBranchName,
         repo: info.repository.url

automation/utils/src/oss-readme.ts

@@ -0,0 +1,17 @@
+import { parse } from "path";
+import { find } from "./shell";
+
+export function findOssReadme(packageRoot: string, widgetName: string, version: string): string | undefined {
+    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");
+    });
+
+    return matchingFiles[0];
+}

automation/utils/src/steps.ts

@@ -14,6 +14,7 @@ import { ModuleInfo, PackageInfo, WidgetInfo } from "./package-info";
 import { addFilesToPackageXml, PackageType } from "./package-xml";
 import { chmod, cp, ensureFileExists, exec, find, mkdir, popd, pushd, rm, unzip, zip } from "./shell";
 import chalk from "chalk";
+import { findOssReadme } from "./oss-readme";
 
 type Step<Info, Config> = (params: { info: Info; config: Config }) => Promise<void>;
 
@@ -205,30 +206,17 @@ export async function addREADMEOSSToMpk({ config, info }: ModuleStepParams): Pro
     const version = info.version.format();
 
     // We'll search for files matching the name and version, ignoring timestamp
-    const readmeossPattern = `*${widgetName}__${version}__READMEOSS_*.html`;
+    const readmeossFile = findOssReadme(packageRoot, widgetName, version);
 
-    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}`
-        );
+    if (!readmeossFile) {
+        console.warn(`⚠️  READMEOSS file not found for ${widgetName} version ${version}.`);
         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");