Merge pull request #511 from abraham/setup

apply overrides on setup and update

Author: abraham

.github/workflows/update.yml

@@ -29,7 +29,7 @@ jobs:
         run: npm ci
 
       - name: Update docs SHA
-        run: npm run update-docs-sha
+        run: npm run update-docs
 
       - name: Install dependencies
         run: npm ci

README.md

@@ -17,7 +17,7 @@ Generate the most accurate OpenAPI spec for the current stable release of Mastod
 ### Update documentation version
 
 ```bash
-npm run update-docs-sha
+npm run update-docs
 ```
 
 ### Generate Schema

package.json

@@ -18,7 +18,7 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "postinstall": "ts-node scripts/setup-docs.ts",
-    "update-docs-sha": "ts-node scripts/update-docs-sha.ts"
+    "update-docs": "ts-node scripts/update-docs.ts"
   },
   "keywords": [
     "mastodon",

scripts/apply-overrides.ts

@@ -0,0 +1,83 @@
+#!/usr/bin/env ts-node
+
+import fs from 'fs';
+import path from 'path';
+import { execSync } from 'child_process';
+
+/**
+ * Apply override commits to the mastodon-documentation repository
+ */
+function applyOverrides(): void {
+  const configPath = path.join(__dirname, '..', 'config.json');
+  const docsDir = path.join(__dirname, '..', 'mastodon-documentation');
+
+  if (!fs.existsSync(configPath)) {
+    console.error('config.json not found');
+    process.exit(1);
+  }
+
+  if (!fs.existsSync(docsDir)) {
+    console.error(
+      'mastodon-documentation directory not found. Run setup-docs first.'
+    );
+    process.exit(1);
+  }
+
+  const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+  const overrideCommits = config.overrideCommits || [];
+  const overridesRepository = config.overridesRepository;
+
+  // Exit early if no overrides to apply
+  if (overrideCommits.length === 0) {
+    console.log('No override commits to apply.');
+    return;
+  }
+
+  console.log(`Applying ${overrideCommits.length} override commit(s)...`);
+
+  try {
+    // Configure git user for cherry-picking
+    console.log('Configuring git user...');
+    execSync(`git config user.email "[email protected]"`, {
+      stdio: 'inherit',
+      cwd: docsDir,
+    });
+    execSync(`git config user.name "bot"`, {
+      stdio: 'inherit',
+      cwd: docsDir,
+    });
+
+    // Add overrides remote if repository is specified
+    if (overridesRepository) {
+      console.log(`Adding ${overridesRepository} overrides remote...`);
+      execSync(`git remote add overrides ${overridesRepository} || true`, {
+        stdio: 'inherit',
+        cwd: docsDir,
+      });
+      execSync(`git fetch overrides`, {
+        stdio: 'inherit',
+        cwd: docsDir,
+      });
+    }
+
+    // Apply each override commit
+    for (const commit of overrideCommits) {
+      console.log(`Cherry-picking commit ${commit}...`);
+      execSync(`git cherry-pick ${commit}`, {
+        stdio: 'inherit',
+        cwd: docsDir,
+      });
+    }
+
+    console.log('Override commits applied successfully.');
+  } catch (error) {
+    console.error('Error applying override commits:', (error as Error).message);
+    process.exit(1);
+  }
+}
+
+if (require.main === module) {
+  applyOverrides();
+}
+
+export { applyOverrides };

scripts/setup-docs.ts

@@ -3,6 +3,7 @@
 import fs from 'fs';
 import path from 'path';
 import { execSync } from 'child_process';
+import { applyOverrides } from './apply-overrides';
 
 /**
  * Setup Mastodon documentation repository at the configured commit SHA
@@ -18,8 +19,6 @@ function setupMastodonDocs(): void {
 
   const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
   const targetCommit = config.mastodonDocsCommit;
-  const overrideCommits = config.overrideCommits || [];
-  const overridesRepository = config.overridesRepository;
 
   if (!targetCommit) {
     console.error('mastodonDocsCommit not found in config.json');
@@ -54,35 +53,8 @@ function setupMastodonDocs(): void {
       cwd: docsDir,
     });
 
-    // Apply override commits if any
-    if (overrideCommits.length > 0) {
-      console.log(`Adding ${overridesRepository} overrides remote...`);
-      execSync(`git config user.email "[email protected]"`, {
-        stdio: 'inherit',
-        cwd: docsDir,
-      });
-      execSync(`git config user.name "bot"`, {
-        stdio: 'inherit',
-        cwd: docsDir,
-      });
-      execSync(`git remote add overrides ${overridesRepository} || true`, {
-        stdio: 'inherit',
-        cwd: docsDir,
-      });
-      execSync(`git fetch overrides`, {
-        stdio: 'inherit',
-        cwd: docsDir,
-      });
-
-      console.log(`Applying ${overrideCommits.length} override commit(s)...`);
-      for (const commit of overrideCommits) {
-        console.log(`Cherry-picking commit ${commit}...`);
-        execSync(`git cherry-pick ${commit}`, {
-          stdio: 'inherit',
-          cwd: docsDir,
-        });
-      }
-    }
+    // Apply override commits
+    applyOverrides();
 
     console.log('Mastodon documentation setup complete.');
   } catch (error) {

scripts/update-docs-sha.ts scripts/update-docs.tsscripts/update-docs-sha.ts renamed to scripts/update-docs.ts

@@ -3,6 +3,7 @@
 import fs from 'fs';
 import path from 'path';
 import { execSync } from 'child_process';
+import { applyOverrides } from './apply-overrides';
 
 /**
  * Update the mastodonDocsCommit in config.json to the latest commit from main branch
@@ -28,9 +29,16 @@ function updateDocsCommit(): boolean {
   );
 
   try {
-    // Pull the latest changes from the remote repository
-    console.log('Pulling latest changes...');
-    execSync('git pull origin main', {
+    // Fetch the latest changes from the remote repository
+    console.log('Fetching latest changes...');
+    execSync('git fetch origin', {
+      cwd: docsDir,
+      stdio: 'inherit',
+    });
+
+    // Reset local branch to match origin/main, discarding any local changes
+    console.log('Resetting to origin/main...');
+    execSync('git reset --hard origin/main', {
       cwd: docsDir,
       stdio: 'inherit',
     });
@@ -61,6 +69,10 @@ function updateDocsCommit(): boolean {
     console.log(
       `Updated mastodonDocsCommit from ${oldCommit} to ${latestCommit}`
     );
+
+    // Apply override commits
+    applyOverrides();
+
     return true;
   } catch (error) {
     console.error('Error updating docs commit:', (error as Error).message);

src/__tests__/scripts.test.ts

@@ -9,8 +9,8 @@ describe('Scripts', () => {
     expect(fs.existsSync(setupDocsPath)).toBe(true);
   });
 
-  it('should have update-docs-sha.ts script', () => {
-    const updateShaPath = path.join(scriptsDir, 'update-docs-sha.ts');
+  it('should have update-docs.ts script', () => {
+    const updateShaPath = path.join(scriptsDir, 'update-docs.ts');
     expect(fs.existsSync(updateShaPath)).toBe(true);
   });
 
@@ -20,7 +20,7 @@ describe('Scripts', () => {
   });
 
   it('should export updateDocsCommit function', async () => {
-    const { updateDocsCommit } = await import('../../scripts/update-docs-sha');
+    const { updateDocsCommit } = await import('../../scripts/update-docs');
     expect(typeof updateDocsCommit).toBe('function');
   });
 });