@apify/docs-theme 1.0.43 → 1.0.45

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apify/docs-theme",
-  "version": "1.0.43",
+  "version": "1.0.45",
   "description": "",
   "main": "./src/index.js",
   "files": [

package/src/markdown.js

@@ -0,0 +1,31 @@
+function updateChangelog(changelog) {
+    changelog = addHeader(changelog);
+    changelog = pushHeadings(changelog);
+    changelog = linkUsers(changelog);
+    changelog = linkPRs(changelog);
+    return changelog;
+}
+
+function addHeader(changelog, header = 'Changelog') {
+    return `---
+title: ${header}
+sidebar_label: ${header}
+---
+${changelog}`;
+}
+
+function pushHeadings(changelog) {
+    return changelog.replaceAll(/\n#[^#]/g, '\n## ');
+}
+
+function linkUsers(changelog) {
+    return changelog.replaceAll(/@([a-zA-Z0-9-]+)/g, '[@$1](https://github.com/$1)');
+}
+
+function linkPRs(changelog) {
+    return changelog.replaceAll(/(((https?:\/\/)?(www.)?)?github.com\/[^\s]*?\/pull\/([0-9]+))/g, '[#$5]($1)');
+}
+
+module.exports = {
+    updateChangelog,
+};

package/src/theme.js

@@ -1,6 +1,7 @@
 const path = require('path');
 const fs = require('fs');
 const axios = require('axios');
+const { updateChangelog } = require('./markdown');
 
 function findPathInParent(endPath) {
     let parentPath = __dirname;
@@ -21,17 +22,6 @@ function findPathInParentOrThrow(endPath) {
     return filePath;
 }
 
-function updateChangelog(changelogPath) {
-    const changelog = fs.readFileSync(changelogPath, 'utf-8');
-    const updated = `---
-title: Changelog
-sidebar_label: Changelog
----
-
-${changelog.replaceAll(/\n#[^#]/g, '\n## ')}`;
-    fs.writeFileSync(changelogPath, updated, 'utf-8');
-}
-
 async function copyChangelogFromReleases(paths, repo) {
     const response = await axios.get(`https://api.github.com/repos/${repo}/releases`);
     const releases = response.data;
@@ -39,16 +29,15 @@ async function copyChangelogFromReleases(paths, repo) {
     let markdown = '';
     if (!Array.isArray(releases) || releases.length === 0) return;
 
-    releases.forEach((release, i, a) => {
-        markdown += release.tag_name && a[i + 1]?.tag_name
-            ? `## [${release.name}](https://github.com/${repo}/compare/${a[i + 1].tag_name}...${release.tag_name})\n`
+    releases.forEach((release) => {
+        markdown += release.tag_name
+            ? `## [${release.name}](https://github.com/${repo}/releases/tag/${release.tag_name})\n`
             : `## ${release.name}\n`;
         markdown += `${release.body.replaceAll(/(^##|\n##)/g, '###')}\n`;
     });
 
     paths.forEach((p) => {
-        fs.writeFileSync(`${p}/changelog.md`, markdown);
-        updateChangelog(`${p}/changelog.md`);
+        fs.writeFileSync(`${p}/changelog.md`, updateChangelog(markdown));
     });
 }
 
@@ -58,8 +47,8 @@ function copyChangelogFromRoot(paths) {
     for (const docsPath of paths) {
         if (fs.existsSync(path.join(docsPath, 'changelog.md')) && fs.statSync(
             path.join(docsPath, 'changelog.md')).mtime >= fs.statSync(changelogPath).mtime) continue;
-        fs.copyFileSync(changelogPath, path.join(docsPath, 'changelog.md'));
-        updateChangelog(path.join(docsPath, 'changelog.md'));
+        const changelog = fs.readFileSync(changelogPath, 'utf-8');
+        fs.writeFileSync(`${docsPath}/changelog.md`, updateChangelog(changelog));
     }
 }