Function initGitHub

src/init/features/hosting/github.ts:55–214

(setup: Setup)

 * @param options Command line options.
 */
export async function initGitHub(setup: Setup): Promise<void> {
  if (!setup.projectId) {
    return reject("Could not determine Project ID, can't set up GitHub workflow.", { exit: 1 });
  }

  if (!setup.config.hosting && !setup.featureInfo?.hosting) {
    return reject(
      `Didn't find a Hosting config in firebase.json. Run ${bold("firebase init hosting")} instead.`,
    );
  }

  logger.info();

  // Find existing Git/Github config
  const gitRoot = getGitFolderPath();
  GIT_DIR = path.join(gitRoot, ".git");
  GITHUB_DIR = path.join(gitRoot, ".github");
  WORKFLOW_DIR = `${GITHUB_DIR}/workflows`;
  YML_FULL_PATH_PULL_REQUEST = `${WORKFLOW_DIR}/${YML_PULL_REQUEST_FILENAME}`;
  YML_FULL_PATH_MERGE = `${WORKFLOW_DIR}/${YML_MERGE_FILENAME}`;

  // GitHub Oauth
  logBullet(
    "Authorizing with GitHub to upload your service account to a GitHub repository's secrets store.",
  );

  const ghAccessToken = await signInWithGitHub();

  // Get GitHub user Details
  const userDetails = await getGitHubUserDetails(ghAccessToken);
  const ghUserName = userDetails.login;

  logger.info();
  logSuccess(`Success! Logged into GitHub as ${bold(ghUserName)}`);
  logger.info();

  // Prompt for repo and validate by getting the public key
  const { repo, key, keyId } = await promptForRepo(setup, ghAccessToken);

  const { default_branch: defaultBranch, id: repoId } = await getRepoDetails(repo, ghAccessToken);

  // Valid secret names:
  // https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#naming-your-secrets
  const githubSecretName = `FIREBASE_SERVICE_ACCOUNT_${setup.projectId
    .replace(/-/g, "_")
    .toUpperCase()}`;

  const serviceAccountName = `github-action-${repoId}`;

  const serviceAccountJSON = await createServiceAccountAndKeyWithRetry(
    setup,
    repo,
    serviceAccountName,
  );

  logger.info();
  logSuccess(
    `Created service account ${bold(serviceAccountName)} with Firebase Hosting admin permissions.`,