Merge pull request #244 from semantic-release/fix/readme

fix: Fixed readme copying

Author: seebeen

lib/prepare.ts

@@ -10,6 +10,13 @@ import { replaceVersions } from './utils/replace-versions.js';
 import { copyFiles } from './utils/copy-files.js';
 import { copyAssets } from './utils/copy-assets.js';
 
+function getReadmePath(workDir: string): string | undefined {
+  return ['.wordpress-org/readme.txt', 'readme.txt'].reduce(
+    (acc, p) => (fs.existsSync(path.join(workDir, p)) ? p : acc),
+    undefined,
+  );
+}
+
 export async function prepare(
   config: PluginConfig,
   context: PrepareContext,
@@ -32,14 +39,9 @@ export async function prepare(
     await fs.copy(path.resolve(config.path), workDir);
   }
 
-  if (config.withReadme) {
-    const readmePath = ['.wordpress-org/readme.txt', 'readme.txt'].reduce(
-      (acc, p) => (fs.existsSync(path.join(workDir, p)) ? p : acc),
-      undefined,
-    );
+  const readmePath = config.withReadme ? getReadmePath(workDir) : undefined;
 
-    readmePath && files.push(readmePath);
-  }
+  readmePath && files.push(readmePath);
 
   errors.push(
     ...(await replaceVersions(workDir, files, context.nextRelease.version)),
@@ -49,7 +51,7 @@ export async function prepare(
     throw new AggregateError(errors);
   }
 
-  errors.push(...(await copyFiles(config, workDir)));
+  errors.push(...(await copyFiles(config, workDir, readmePath)));
 
   if (errors.length) {
     throw new AggregateError(errors);

lib/utils/copy-files.ts

@@ -63,6 +63,7 @@ export function getIgnore(workDir: string, files?: string[]): string[] {
 export async function copyFiles(
   config: PluginConfig,
   workDir: string,
+  readmePath?: string,
 ): Promise<SemanticReleaseError[]> {
   const errors: SemanticReleaseError[] = [];
   const releasePath = path.resolve(config.releasePath, config.slug);
@@ -91,5 +92,20 @@ export async function copyFiles(
     }
   }
 
+  if (config.withReadme && readmePath) {
+    try {
+      fs.cpSync(
+        path.resolve(path.join(workDir, readmePath)),
+        path.resolve(path.join(releasePath, 'readme.txt')),
+        {
+          preserveTimestamps: true,
+          recursive: true,
+        },
+      );
+    } catch (err) {
+      errors.push(getError('EFILECOPY', readmePath));
+    }
+  }
+
   return errors;
 }

test/2-prepare-plugin.spec.ts

@@ -103,10 +103,7 @@ describe('Package preparation - cusom work directory', () => {
     );
 
     const readme = fs.readFileSync(
-      path.join(
-        getWorkDir(workDir),
-        'plugin-with-readme/.wordpress-org/readme.txt',
-      ),
+      path.join(releasePath, 'plugin-with-readme/readme.txt'),
       'utf8',
     );