Propose a release preamble

.changeset/.PREAMBLE.md

@@ -0,0 +1,8 @@
+This version of skuba should not be a large upgrade effort for most use-cases, but does contains some large changes:
+
+- Major upgrades to the linting and patching systems, which may result in some code changes on version upgrades.
+  To make upgrades easy now and going forward, we recommend setting up [GitHub autofixes](https://seek-oss.github.io/skuba/docs/deep-dives/github.html#github-autofixes).
+- New projects will now be initialised with `pnpm`.
+  A future release of `skuba` will likely transition existing projects to `pnpm` as well.
+
+Continue reading for more details on these changes and other improvements in this release.

.changeset/inject.js

@@ -0,0 +1,16 @@
+// Hack to add a preamble from .changeset/.PREAMBLE.md to the CHANGELOG.md for a given release
+
+const fs = require('fs');
+
+const PREAMBLE_PATH = '.changeset/.PREAMBLE.md';
+const CHANGELOG_PATH = 'CHANGELOG.md';
+
+if (fs.existsSync(PREAMBLE_PATH) && fs.existsSync(CHANGELOG_PATH)) {
+  const preamble = fs.readFileSync(PREAMBLE_PATH, 'utf8');
+  const changeset = fs.readFileSync(CHANGELOG_PATH, 'utf8');
+
+  const lines = changeset.split('\n');
+  lines.splice(3, 0, preamble);
+  fs.writeFileSync(CHANGELOG_PATH, lines.join('\n'));
+  fs.rmSync(PREAMBLE_PATH);
+}

package.json

@@ -37,7 +37,7 @@
     "release": "pnpm run --silent build && changeset publish",
     "skuba": "pnpm run --silent build && pnpm run --silent skuba:exec",
     "skuba:exec": "node --env-file=.env lib/skuba",
-    "stage": "changeset version && pnpm run format",
+    "stage": "changeset version && node ./.changeset/inject.js && pnpm run format",
     "test": "pnpm run --silent skuba test --selectProjects unit",
     "test:ci": "pnpm run --silent skuba test --runInBand",
     "test:int": "pnpm run --silent skuba test --runInBand --selectProjects integration",