docs: new changelog

Author: mrlubos

.changeset/changelog.js

@@ -30,8 +30,11 @@ export default {
     /** @type string[] */
     const usersFromSummary = [];
 
+    // Parse summary to extract scope and description
+    const summary = changeset.summary;
+
     // Remove PR, commit, author/user lines from summary
-    const replacedChangelog = changeset.summary
+    const replacedChangelog = summary
       .replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
         const num = Number(pr);
         if (!Number.isNaN(num)) {
@@ -49,6 +52,24 @@ export default {
       })
       .trim();
 
+    // Detect scope from **scope**: format
+    const scopeMatch = replacedChangelog.match(/^\*\*([^:]+)\*\*:?\s*(.*)$/);
+    const scope = scopeMatch ? scopeMatch[1] : null;
+    const description = scopeMatch ? scopeMatch[2] : replacedChangelog;
+
+    // Detect breaking changes (explicit BREAKING or major version) - for future use
+    const explicitBreaking =
+      /^BREAKING[:\s]/i.test(replacedChangelog) || /\bBREAKING CHANGE\b/i.test(replacedChangelog);
+    void explicitBreaking;
+
+    // Build formatted entry
+    const entryParts = [];
+    if (scope) {
+      entryParts.push(`**${scope}**: ${description}`);
+    } else {
+      entryParts.push(description);
+    }
+
     const links = await (async () => {
       if (prFromSummary !== undefined) {
         let { links } = await getInfoFromPullRequest({
@@ -81,27 +102,13 @@ export default {
       };
     })();
 
-    const users = usersFromSummary.length
-      ? usersFromSummary
-          .map((userFromSummary) => `[@${userFromSummary}](https://github.com/${userFromSummary})`)
-          .join(', ')
-      : links.user;
-
-    const metadata = [
-      links.pull === null ? '' : ` (${links.pull})`,
-      links.commit === null ? '' : ` (${links.commit})`,
-      users === null ? '' : ` by ${users}`,
-    ].join('');
-
-    // Split summary into first line and the rest
-    const [firstLine, ...rest] = replacedChangelog.split('\n');
-    const restSummary = rest.join('\n').trim();
-
-    // No code block conversion: preserve original triple backtick code blocks and indentation
-    let releaseLine = `\n- ${firstLine}${metadata}`;
-    if (restSummary) {
-      releaseLine += '\n\n' + restSummary;
+    // Add PR link at end
+    if (links.pull) {
+      entryParts.push(`(${links.pull})`);
+    } else if (prFromSummary !== undefined) {
+      entryParts.push(`([#${prFromSummary}](https://github.com/${repo}/pull/${prFromSummary}))`);
     }
-    return releaseLine;
+
+    return `\n- ${entryParts.join(' ')}`;
   },
 };

.changeset/config.json

@@ -2,7 +2,7 @@
   "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
   "access": "public",
   "baseBranch": "main",
-  "changelog": "./changelog.js",
+  "changelog": ["./changelog.js", { "repo": "hey-api/openapi-ts" }],
   "commit": false,
   "fixed": [],
   "ignore": [],

.github/workflows/release.yml

@@ -49,13 +49,32 @@ jobs:
         uses: changesets/action@v1.7.0
         with:
           commit: 'ci: release'
+          createGithubReleases: false
           publish: pnpm changeset publish
           title: 'ci: release'
-          version: pnpm changeset version
+          version: pnpm changeset version && pnpm changelog:assemble
         env:
           GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
           NPM_CONFIG_PROVENANCE: true
 
+      - name: Generate Release Tag
+        id: tag
+        run: echo "tag=$(pnpm changelog:release:tag)" >> $GITHUB_OUTPUT
+
+      - name: Generate Release Notes
+        id: notes
+        run: pnpm changelog:release:notes > release-notes.md
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.tag.outputs.tag }}
+          name: Release ${{ steps.tag.outputs.tag }}
+          body_path: release-notes.md
+          generate_release_notes: false
+        env:
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+
       - name: Get current branch
         run: echo "CURRENT_BRANCH=$(git branch --show-current)" >> $GITHUB_ENV