docs: Add upgrade guide and breaking changes (#860)

2024-07-25 19:59:15 -05:00
parent c8ddc66cfa
commit b4b69783d5
4 changed files with 300 additions and 200 deletions
@@ -49,11 +49,17 @@ const versionChangelog = await generateMarkDown(commits, {
  from: prevTag,
  to: newTag,
 });
-const versionChangelogBody = versionChangelog
+let versionChangelogBody = versionChangelog
  .split('\n')
  .slice(1)
  .join('\n')
  .trim();
+if (bumpType === 'major') {
+  versionChangelogBody = versionChangelogBody.replace(
+    '[compare changes]',
+    `[⚠️ breaking changes](https://wxt.dev/guide/upgrade-guide/wxt) &bull; [compare changes]`,
+  );
+}
 const { releases: prevReleases } = await fs
  .readFile(changelogPath, 'utf8')
  .then(parseChangelogMarkdown)