@aspruyt/xfg 3.10.3 → 3.12.0

package/dist/lifecycle/github-lifecycle-provider.d.ts

@@ -47,6 +47,11 @@ export declare class GitHubLifecycleProvider implements IRepoLifecycleProvider {
      */
     private applyRepoSettings;
     receiveMigration(repoInfo: RepoInfo, sourceDir: string, settings?: CreateRepoSettings, token?: string): Promise<void>;
+    /**
+     * Rename a branch via the GitHub branch rename API.
+     * GitHub automatically updates the default branch pointer.
+     */
+    private renameBranch;
     /**
      * Delete the README.md that --add-readme creates.
      * This leaves the repo with a default branch established (from the initial

package/dist/lifecycle/github-lifecycle-provider.js

@@ -149,6 +149,24 @@ export class GitHubLifecycleProvider {
         await withRetry(() => this.executor.exec(command, this.cwd), {
             retries: this.retries,
         });
+        // Rename default branch if requested and it differs from what GitHub created.
+        if (settings?.defaultBranch) {
+            const tokenPrefix = this.buildTokenPrefix(token);
+            const hostnameFlag = getHostnameFlag(repoInfo);
+            const hostnamePart = hostnameFlag ? `${hostnameFlag} ` : "";
+            const apiPath = `repos/${escapeShellArg(repoInfo.owner)}/${escapeShellArg(repoInfo.repo)}`;
+            // After repo creation, GitHub may return 404 due to eventual consistency.
+            // Exclude 404/not-found from permanent errors so withRetry retries them.
+            const postCreatePermanentPatterns = DEFAULT_PERMANENT_ERROR_PATTERNS.filter((p) => !p.test("404 Not Found"));
+            // Detect the actual default branch name
+            const actualBranch = (await withRetry(() => this.executor.exec(`${tokenPrefix}gh api ${hostnamePart}${apiPath} --jq '.default_branch'`, this.cwd), {
+                retries: this.retries,
+                permanentErrorPatterns: postCreatePermanentPatterns,
+            })).trim();
+            if (actualBranch !== settings.defaultBranch) {
+                await this.renameBranch(repoInfo, actualBranch, settings.defaultBranch, token);
+            }
+        }
         // Delete the README so xfg sync starts from a clean state.
         await this.deleteReadme(repoInfo, token);
     }
@@ -258,6 +276,20 @@ export class GitHubLifecycleProvider {
         catch {
             // No refs to remove — ignore
         }
+        // Rename default branch in mirror clone if requested.
+        if (settings?.defaultBranch) {
+            const headRef = (await this.executor.exec(`git -C ${escapeShellArg(sourceDir)} symbolic-ref HEAD`, this.cwd)).trim();
+            const prefix = "refs/heads/";
+            if (!headRef.startsWith(prefix)) {
+                throw new Error(`Mirror clone HEAD symbolic-ref is '${headRef}', expected to start with '${prefix}'. ` +
+                    `Cannot rename default branch.`);
+            }
+            const sourceBranch = headRef.slice(prefix.length);
+            if (sourceBranch !== settings.defaultBranch) {
+                await this.executor.exec(`git -C ${escapeShellArg(sourceDir)} branch -m ${escapeShellArg(sourceBranch)} ${escapeShellArg(settings.defaultBranch)}`, this.cwd);
+                await this.executor.exec(`git -C ${escapeShellArg(sourceDir)} symbolic-ref HEAD refs/heads/${escapeShellArg(settings.defaultBranch)}`, this.cwd);
+            }
+        }
         // Use gh repo create --source --push to create and mirror in one step.
         // For bare repos (from git clone --mirror), --push mirrors all refs.
         // This uses gh CLI authentication, avoiding raw git auth issues with GHE.
@@ -294,6 +326,20 @@ export class GitHubLifecycleProvider {
             retries: this.retries,
         });
     }
+    /**
+     * Rename a branch via the GitHub branch rename API.
+     * GitHub automatically updates the default branch pointer.
+     */
+    async renameBranch(repoInfo, current, desired, token) {
+        const renameTokenPrefix = this.buildTokenPrefix(token);
+        const hostnameFlag = getHostnameFlag(repoInfo);
+        const hostnamePart = hostnameFlag ? `${hostnameFlag} ` : "";
+        const apiPath = `repos/${escapeShellArg(repoInfo.owner)}/${escapeShellArg(repoInfo.repo)}`;
+        await withRetry(() => this.executor.exec(`${renameTokenPrefix}gh api ${hostnamePart}${apiPath}/branches/${escapeShellArg(current)}/rename ` +
+            `--method POST -f new_name=${escapeShellArg(desired)}`, this.cwd), {
+            retries: this.retries,
+        });
+    }
     /**
      * Delete the README.md that --add-readme creates.
      * This leaves the repo with a default branch established (from the initial

package/dist/lifecycle/lifecycle-helpers.js

@@ -17,6 +17,8 @@ export function toCreateRepoSettings(repo) {
         result.hasIssues = repo.hasIssues;
     if (repo.hasWiki !== undefined)
         result.hasWiki = repo.hasWiki;
+    if (repo.defaultBranch !== undefined)
+        result.defaultBranch = repo.defaultBranch;
     return Object.keys(result).length > 0 ? result : undefined;
 }
 /**

package/dist/lifecycle/types.d.ts

@@ -37,6 +37,7 @@ export interface CreateRepoSettings {
     description?: string;
     hasIssues?: boolean;
     hasWiki?: boolean;
+    defaultBranch?: string;
 }
 /**
  * Provider for platform-specific lifecycle operations.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspruyt/xfg",
-  "version": "3.10.3",
+  "version": "3.12.0",
   "description": "Manage files, settings, and repositories across GitHub, Azure DevOps, and GitLab — declaratively, from a single YAML config",
   "type": "module",
   "main": "dist/index.js",