Use the changelog from the monorepo root in each package

[NullVoxPopuli]

release-plan uses a single changelog for all packages in the monorepo.

This PR copies that single changelog to the workspace directory during build (and consequently, during prepack) so there is a changelog distributed with package changes.

This provides context to each change, so when folks review the changes in a PR, they'll see what other packages changed, and which other packages may also be a good idea to update at the same time.

Lastly, because the changelog is copied from the root, all package-based changelogs are gitignored.

script used to apply these changes

import path from "node:path";
import { project, packageJson } from "ember-apply";
import fse from "fs-extra";

await project.gitIgnore("**/CHANGELOG.md");

for (let workspace of await project.getWorkspaces()) {
  let manifest = await packageJson.read(workspace);

  if (manifest.private || !manifest.name) continue;

  try {
    await workOn(workspace);
  } catch (e) {
    console.error(workspace);
    console.error(e);
  }
}

async function workOn(workspace) {
  let rollupPath = path.join(workspace, "rollup.config.mjs");
  let hasRollup = await fse.pathExists(rollupPath);

  if (!hasRollup) {
    return;
  }

  await fse.remove(path.join(workspace, "CHANGELOG.md"));

  await packageJson.addDevDependencies(
    { "rollup-plugin-copy": "^3.5.0" },
    workspace,
  );

  await fse.writeFile(
    rollupPath,
    `
import path from 'node:path';
import { execSync } from 'node:child_process';
import { compile } from "@starbeam-dev/compile";
import copy from 'rollup-plugin-copy'

const config = compile(import.meta);

const monorepoRoot = execSync('git rev-parse --show-toplevel', { encoding: 'utf-8' }).trim();

const rootChangelog = path.join(monorepoRoot, 'CHANGELOG.md');

// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment
const includeChangelog = copy({ 
  targets: [
    {
      src: rootChangelog,
      dest: 'CHANGELOG.md',
    }
  ],
});

// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment
config[0].plugins.push(includeChangelog);

export default config;
`,
  );
}

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[socket-security]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@starbeam-dev/compile	1.0.2	environment	+2550	15.8 GB	wycats