@teambit/ci 1.0.636 → 1.0.638

package/ci.docs.mdx

@@ -243,16 +243,22 @@ bit ci sync --init
 ```
 
 `--init` writes `.github/workflows/bit-sync.yml` and `bit-release.yml`, with the real default branch of this
-repository in both files. `--init` adds `"teambit.git/ci": { "sync": {} }` to `workspace.jsonc` if the key is
+repository in both files. When the workspace is below the repository root, `--init` writes the files at the
+root and sets `ws-dir` to the workspace directory in both. `--init` adds `"teambit.git/ci": { "sync": {} }` to `workspace.jsonc` if the key is
 absent. The edit keeps the comments in the file, and it changes no existing `sync` setting. `--init` then
-prints the steps that need a person:
+prints one short report: the files it changed, and three steps that need a person, as commands to paste:
 
-- the `BIT_CONFIG_ACCESS_TOKEN` secret
-- the optional `BIT_SYNC_GH_TOKEN` token
-- the bit.cloud webhook recipe
-- a `fetch-depth: 0` reminder
+1. Commit the files `--init` changed, and push. With no `origin`, create the repository with `gh repo create`.
+2. Set the `BIT_CONFIG_ACCESS_TOKEN` secret, allow GitHub Actions to open pull requests, and optionally set
+   the `BIT_SYNC_GH_TOKEN` secret.
+3. Optional: make Bit -> Git instant. On github.com, install the `bit-git-sync` GitHub App and add its
+   webhook URL to the scope. On GitHub Enterprise Server, add a webhook that calls the repository
+   `dispatches` API.
 
-`--init` reports an existing file as skipped, and overwrites no file, so a second run is safe. `--init`
+The commands name the repository of `origin`. When `origin` is not a GitHub remote yet, `--init` prints
+only the push step, then tells you to run `--init` again after you push.
+
+`--init` reports an existing file as unchanged, and overwrites no file, so a second run is safe. `--init`
 writes the files, then exits. Do not combine `--init` with a lane argument or with another flag.
 
 ### Usage

package/commands/sync.cmd.ts

@@ -61,9 +61,12 @@ export class CiSyncCmd implements Command {
   // `[lane]: [string]` rather than `[string?]`: `CLIArgs` does not admit an undefined-carrying tuple.
   // The argument is genuinely optional at runtime, hence the `|| undefined` below.
   async report([lane]: [string], options: Options) {
-    this.logger.console('\n\n');
-    this.logger.console('Initializing sync command');
     if (!this.workspace) throw new OutsideWorkspaceError();
+    // --init prints its own report; the banner only frames a reconcile run.
+    if (!options.init) {
+      this.logger.console('\n\n');
+      this.logger.console('Initializing sync command');
+    }
 
     return this.ci.sync({
       lane: lane || undefined,

package/dist/ci.docs.mdx

@@ -243,16 +243,22 @@ bit ci sync --init
 ```
 
 `--init` writes `.github/workflows/bit-sync.yml` and `bit-release.yml`, with the real default branch of this
-repository in both files. `--init` adds `"teambit.git/ci": { "sync": {} }` to `workspace.jsonc` if the key is
+repository in both files. When the workspace is below the repository root, `--init` writes the files at the
+root and sets `ws-dir` to the workspace directory in both. `--init` adds `"teambit.git/ci": { "sync": {} }` to `workspace.jsonc` if the key is
 absent. The edit keeps the comments in the file, and it changes no existing `sync` setting. `--init` then
-prints the steps that need a person:
+prints one short report: the files it changed, and three steps that need a person, as commands to paste:
 
-- the `BIT_CONFIG_ACCESS_TOKEN` secret
-- the optional `BIT_SYNC_GH_TOKEN` token
-- the bit.cloud webhook recipe
-- a `fetch-depth: 0` reminder
+1. Commit the files `--init` changed, and push. With no `origin`, create the repository with `gh repo create`.
+2. Set the `BIT_CONFIG_ACCESS_TOKEN` secret, allow GitHub Actions to open pull requests, and optionally set
+   the `BIT_SYNC_GH_TOKEN` secret.
+3. Optional: make Bit -> Git instant. On github.com, install the `bit-git-sync` GitHub App and add its
+   webhook URL to the scope. On GitHub Enterprise Server, add a webhook that calls the repository
+   `dispatches` API.
 
-`--init` reports an existing file as skipped, and overwrites no file, so a second run is safe. `--init`
+The commands name the repository of `origin`. When `origin` is not a GitHub remote yet, `--init` prints
+only the push step, then tells you to run `--init` again after you push.
+
+`--init` reports an existing file as unchanged, and overwrites no file, so a second run is safe. `--init`
 writes the files, then exits. Do not combine `--init` with a lane argument or with another flag.
 
 ### Usage

package/dist/ci.main.runtime.d.ts

@@ -137,14 +137,16 @@ export declare class CiMain {
     convertBranchToLaneId(branchName: string): string;
     /**
      * The repository's default branch name, whole — slashes included (see `parseOriginHeadRef`).
-     * Local `origin/HEAD` symref first, then the remote's own answer, then the conventional probe.
+     * What `detectDefaultBranchName` finds, else `master`, with a warning that names it.
      */
     getDefaultBranchName(): Promise<string>;
     /**
-     * Last-resort fallback: the two conventional names among the remote branches, then `master`.
-     * Deliberately only `main`/`master` — any wider guess risks protecting the wrong branch.
+     * The default branch as the repository itself states it: the local `origin/HEAD` symref, then the
+     * remote's own answer, then `main`/`master` among the remote branches. Undefined when none of them
+     * answers (no origin, a repository not pushed yet, a server out of reach), so a caller can tell a
+     * detected branch from a guess.
      */
-    private probeDefaultBranchName;
+    detectDefaultBranchName(): Promise<string | undefined>;
     getGitCommitMessage(): Promise<string | null>;
     private parseVersionBumpFromCommit;
     private getCustomCommitMessage;

package/dist/ci.main.runtime.js

@@ -423,9 +423,22 @@ class CiMain {
 
   /**
    * The repository's default branch name, whole — slashes included (see `parseOriginHeadRef`).
-   * Local `origin/HEAD` symref first, then the remote's own answer, then the conventional probe.
+   * What `detectDefaultBranchName` finds, else `master`, with a warning that names it.
    */
   async getDefaultBranchName() {
+    const detected = await this.detectDefaultBranchName();
+    if (detected) return detected;
+    this.logger.console(_chalk().default.yellow(`Unable to detect default branch, using 'master'`));
+    return 'master';
+  }
+
+  /**
+   * The default branch as the repository itself states it: the local `origin/HEAD` symref, then the
+   * remote's own answer, then `main`/`master` among the remote branches. Undefined when none of them
+   * answers (no origin, a repository not pushed yet, a server out of reach), so a caller can tell a
+   * detected branch from a guess.
+   */
+  async detectDefaultBranchName() {
     try {
       const result = await _git().git.raw(['symbolic-ref', 'refs/remotes/origin/HEAD']);
       const local = (0, _gitOps().parseOriginHeadRef)(result);
@@ -438,23 +451,16 @@ class CiMain {
     }
     const remote = await (0, _gitOps().remoteHeadBranch)();
     if (remote && (0, _syncConfig().isValidGitBranchName)(remote)) return remote;
-    return this.probeDefaultBranchName();
-  }
-
-  /**
-   * Last-resort fallback: the two conventional names among the remote branches, then `master`.
-   * Deliberately only `main`/`master` — any wider guess risks protecting the wrong branch.
-   */
-  async probeDefaultBranchName(originalError) {
+    // Deliberately only `main`/`master` — any wider guess risks protecting the wrong branch.
     try {
       const branches = await _git().git.branch(['-r']);
       if (branches.all.includes('origin/main')) return 'main';
       if (branches.all.includes('origin/master')) return 'master';
-      return 'master';
-    } catch {
-      this.logger.console(_chalk().default.yellow(`Unable to detect default branch, using 'master'${originalError ? `: ${originalError}` : ''}`));
-      return 'master';
+    } catch (err) {
+      // debug only: the caller decides what to say, and what to use instead
+      this.logger.debug(`detectDefaultBranchName: "git branch -r" failed: ${err.message}`);
     }
+    return undefined;
   }
   async getGitCommitMessage() {
     try {