fix: remove race condition from the changelog generation (#1186)

Removes the reintroduced changelog generator race condition. 

Fixes the `options.changelogFromRoot` bug when the default changelog is
never overwritten (default changelog is always newer than the source
changelog) by tracking which changelogs are default and can be
overwritten.

Author: barjin

apify-docs-theme/src/theme.js

@@ -40,18 +40,24 @@ async function generateChangelogFromGitHubReleases(paths, repo) {
     });
 
     paths.forEach((p) => {
-        fs.writeFileSync(`${p}/changelog.md`, updateChangelog(markdown));
+        fs.writeFileSync(path.join(p, 'changelog.md'), updateChangelog(markdown));
     });
 }
 
-function copyChangelogFromRoot(paths) {
-    const changelogPath = findPathInParentOrThrow('CHANGELOG.md');
+function copyChangelogFromRoot(paths, hasDefaultChangelog) {
+    const sourceChangelogPath = findPathInParentOrThrow('CHANGELOG.md');
 
     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;
-        const changelog = fs.readFileSync(changelogPath, 'utf-8');
-        fs.writeFileSync(`${docsPath}/changelog.md`, updateChangelog(changelog));
+        const targetChangelogPath = path.join(docsPath, 'changelog.md');
+
+        if (fs.existsSync(targetChangelogPath)
+            && fs.statSync(targetChangelogPath).mtime >= fs.statSync(sourceChangelogPath).mtime
+            && !hasDefaultChangelog.get(docsPath)) {
+            continue;
+        }
+
+        const changelog = fs.readFileSync(sourceChangelogPath, 'utf-8');
+        fs.writeFileSync(targetChangelogPath, updateChangelog(changelog));
     }
 }
 
@@ -81,11 +87,7 @@ function theme(
                     ),
                 ];
 
-                if (options.changelogFromRoot) {
-                    copyChangelogFromRoot(pathsToCopyChangelog);
-                } else {
-                    await generateChangelogFromGitHubReleases(pathsToCopyChangelog, `${context.siteConfig.organizationName}/${context.siteConfig.projectName}`);
-                }
+                const hasDefaultChangelog = new Map();
 
                 for (const p of pathsToCopyChangelog) {
                     // the changelog page has to exist for the sidebar to work - async loadContent() is (apparently) not awaited for by sidebar
@@ -97,6 +99,13 @@ sidebar_label: Changelog
 It seems that the changelog is not available.
 This either means that your Docusaurus setup is misconfigured, or that your GitHub repository contains no releases yet.
 `);
+                    hasDefaultChangelog.set(p, true);
+                }
+
+                if (options.changelogFromRoot) {
+                    copyChangelogFromRoot(pathsToCopyChangelog, hasDefaultChangelog);
+                } else {
+                    await generateChangelogFromGitHubReleases(pathsToCopyChangelog, `${context.siteConfig.organizationName}/${context.siteConfig.projectName}`);
                 }
             } catch (e) {
                 // eslint-disable-next-line no-console