@teambit/ci 1.0.631 → 1.0.633

package/sync/init-scaffold.spec.ts

@@ -11,6 +11,7 @@ import {
   deriveOwnerRepo,
   renderInitChecklist,
 } from './init-scaffold';
+import type { OwnerRepo } from './init-scaffold';
 
 const yamlLoad = (src: string) => YAML.parse(src);
 
@@ -99,10 +100,11 @@ describe('init-scaffold', () => {
   });
 
   describe('deriveOwnerRepo', () => {
-    const REMOTES: Array<[string | undefined, { owner: string; repo: string } | undefined]> = [
-      ['git@github.com:acme/shop.git', { owner: 'acme', repo: 'shop' }],
-      ['https://github.com/acme/shop.git', { owner: 'acme', repo: 'shop' }],
-      ['https://github.com/acme/shop', { owner: 'acme', repo: 'shop' }],
+    const SHOP = { owner: 'acme', repo: 'shop', host: 'github.com' };
+    const REMOTES: Array<[string | undefined, OwnerRepo | undefined]> = [
+      ['git@github.com:acme/shop.git', SHOP],
+      ['https://github.com/acme/shop.git', SHOP],
+      ['https://github.com/acme/shop', SHOP],
       ['https://gitlab.com/acme/shop.git', undefined],
       // a local/bare remote has no host at all
       ['/path/to/bare.git', undefined],
@@ -117,12 +119,67 @@ describe('init-scaffold', () => {
 
   describe('renderInitChecklist', () => {
     it('renders a real dispatch URL when owner/repo were derived, a placeholder when not', () => {
-      const derived = renderInitChecklist({ owner: 'acme', repo: 'shop' });
+      const derived = renderInitChecklist({ owner: 'acme', repo: 'shop', host: 'github.com' });
       expect(derived).to.contain('https://api.github.com/repos/acme/shop/dispatches');
       expect(derived).to.not.contain('<owner>/<repo>');
       expect(renderInitChecklist(undefined)).to.contain('https://api.github.com/repos/<owner>/<repo>/dispatches');
     });
 
+    it('derives the repository and the dispatch URL from a GitHub Enterprise Server remote', () => {
+      const saved = { api: process.env.GITHUB_API_URL, server: process.env.GITHUB_SERVER_URL };
+      process.env.GITHUB_API_URL = 'https://ghe.corp.example/api/v3';
+      process.env.GITHUB_SERVER_URL = 'https://ghe.corp.example';
+      try {
+        const ownerRepo = deriveOwnerRepo('git@ghe.corp.example:acme/store.git');
+        expect(ownerRepo).to.deep.equal({ owner: 'acme', repo: 'store', host: 'ghe.corp.example' });
+        expect(renderInitChecklist(ownerRepo)).to.contain(
+          'https://ghe.corp.example/api/v3/repos/acme/store/dispatches'
+        );
+      } finally {
+        if (saved.api === undefined) delete process.env.GITHUB_API_URL;
+        else process.env.GITHUB_API_URL = saved.api;
+        if (saved.server === undefined) delete process.env.GITHUB_SERVER_URL;
+        else process.env.GITHUB_SERVER_URL = saved.server;
+      }
+    });
+
+    describe('on a GHES-configured runner', () => {
+      const saved: Record<string, string | undefined> = {};
+      beforeEach(() => {
+        saved.api = process.env.GITHUB_API_URL;
+        saved.server = process.env.GITHUB_SERVER_URL;
+        process.env.GITHUB_SERVER_URL = 'https://ghe.corp.example';
+      });
+      afterEach(() => {
+        if (saved.api === undefined) delete process.env.GITHUB_API_URL;
+        else process.env.GITHUB_API_URL = saved.api;
+        if (saved.server === undefined) delete process.env.GITHUB_SERVER_URL;
+        else process.env.GITHUB_SERVER_URL = saved.server;
+      });
+
+      it('names api.github.com for a github.com origin', () => {
+        process.env.GITHUB_API_URL = 'https://ghe.corp.example/api/v3';
+        const checklist = renderInitChecklist(deriveOwnerRepo('git@github.com:acme/shop.git'));
+        expect(checklist).to.contain('https://api.github.com/repos/acme/shop/dispatches');
+        expect(checklist).to.not.contain('ghe.corp.example');
+      });
+
+      it('derives <server>/api/v3 for an enterprise origin when GITHUB_API_URL is unset', () => {
+        delete process.env.GITHUB_API_URL;
+        expect(renderInitChecklist(deriveOwnerRepo('https://ghe.corp.example/acme/store.git'))).to.contain(
+          'https://ghe.corp.example/api/v3/repos/acme/store/dispatches'
+        );
+      });
+
+      it('names no API for an enterprise origin whose GITHUB_API_URL is on another host', () => {
+        process.env.GITHUB_API_URL = 'https://api.github.com';
+        const checklist = renderInitChecklist(deriveOwnerRepo('https://ghe.corp.example/acme/store.git'));
+        expect(checklist).to.contain('<GitHub API URL>/repos/acme/store/dispatches');
+        expect(checklist).to.contain('GITHUB_API_URL "https://api.github.com"');
+        expect(checklist).to.not.contain('https://api.github.com/repos');
+      });
+    });
+
     it('always includes the secrets, permissions, webhook and fetch-depth checklist items', () => {
       const checklist = renderInitChecklist(undefined);
       [

package/sync/init-scaffold.ts

@@ -1,6 +1,6 @@
 import fs from 'fs';
 import path from 'path';
-import { parseGitHubRepo, isGitHubRemote } from './github-client';
+import { parseGitHubRepo, isGitHubRemote, gitHubApiUrl, remoteHost } from './github-client';
 
 /**
  * `bit ci sync --init` — pure scaffolding logic, unit-testable without a live workspace/git checkout.
@@ -273,6 +273,8 @@ export function scaffoldWorkflowFiles(workspaceDir: string, defaultBranch: strin
 export interface OwnerRepo {
   owner: string;
   repo: string;
+  /** The remote's host — github.com or the GITHUB_SERVER_URL one — which picks the API the checklist names. */
+  host: string;
 }
 
 /**
@@ -283,10 +285,11 @@ export interface OwnerRepo {
 export function deriveOwnerRepo(remoteUrl: string | undefined): OwnerRepo | undefined {
   if (!remoteUrl || !isGitHubRemote(remoteUrl)) return undefined;
   const ownerSlashRepo = parseGitHubRepo(remoteUrl);
-  if (!ownerSlashRepo) return undefined;
+  const host = remoteHost(remoteUrl);
+  if (!ownerSlashRepo || !host) return undefined;
   const [owner, repo] = ownerSlashRepo.split('/');
   if (!owner || !repo) return undefined;
-  return { owner, repo };
+  return { owner, repo, host };
 }
 
 /**
@@ -302,7 +305,8 @@ const WEBHOOK_PAYLOAD_TEMPLATE =
  */
 export function renderInitChecklist(ownerRepo: OwnerRepo | undefined): string {
   const repoSegment = ownerRepo ? `${ownerRepo.owner}/${ownerRepo.repo}` : '<owner>/<repo>';
-  const dispatchUrl = `https://api.github.com/repos/${repoSegment}/dispatches`;
+  const api = gitHubApiUrl(ownerRepo?.host);
+  const dispatchUrl = `${'error' in api ? '<GitHub API URL>' : api.url}/repos/${repoSegment}/dispatches`;
   return [
     '',
     'Remaining manual steps (bit ci sync --init only scaffolds files -- these need a human):',
@@ -322,6 +326,7 @@ export function renderInitChecklist(ownerRepo: OwnerRepo | undefined): string {
     '3. bit.cloud webhook -- create ONE webhook (org Settings > Webhooks) on the "Components > Export',
     '   succeeded" event:',
     `   URL:     ${dispatchUrl}`,
+    ...('error' in api ? [`            (${api.error})`] : []),
     '   Headers: Authorization: Bearer <PAT>',
     '            Accept: application/vnd.github+json',
     '   Custom payload template:',