codeql-action/pr-checks/bundle-changelog.ts

#!/usr/bin/env npx tsx

/**
 * Creates a changenote file for an update to the default CodeQL CLI bundle.
 */

import * as fs from "node:fs";
import * as path from "node:path";

import { CHANGENOTES_DIR, CLI_BUNDLE_RELEASE_URL_PREFIX } from "./config";
import { getErrorMessage } from "./util";

export const CLI_VERSION_ENV_VAR = "CLI_VERSION";
export const PR_URL_ENV_VAR = "PR_URL";

/** Gets the CLI version from the environment. */
export function getCLIVersion() {
  const cliVersion = process.env[CLI_VERSION_ENV_VAR];

  if (cliVersion === undefined || cliVersion.trim() === "") {
    throw new Error(`No CLI version was set in '${CLI_VERSION_ENV_VAR}'.`);
  }

  return cliVersion;
}

/** Gets the PR URL from the environment. */
export function getPRUrl() {
  const prUrl = process.env[PR_URL_ENV_VAR];

  if (prUrl === undefined || prUrl.trim() === "") {
    throw new Error(`No PR URL was set in '${PR_URL_ENV_VAR}'.`);
  }

  return prUrl;
}

/**
 * Gets the PR number from something like a PR URL.
 */
export function getPRNumber(prUrl: string) {
  const prUrlParts = prUrl.split("/");
  const prNumberStr = prUrlParts[prUrlParts.length - 1];

  const prNumber = Number.parseInt(prNumberStr, 10);

  if (!Number.isInteger(prNumber) || prNumber <= 0) {
    throw new Error(
      `Invalid PR URL '${prUrl}': last part is not a positive number`,
    );
  }

  return prNumber;
}

/**
 * Returns the contents of the changenote file for an update to the default
 * CodeQL CLI bundle.
 *
 * @param cliVersion The CodeQL CLI version of the new default bundle.
 * @param prUrl The URL of the PR that updates the default bundle.
 * @throws If the PR number can't be determined from `prUrl`.
 */
export function getChangenote(cliVersion: string, prUrl: string): string {
  // The GitHub Release for the new bundle version.
  const bundleReleaseUrl = `${CLI_BUNDLE_RELEASE_URL_PREFIX}${cliVersion}`;

  const prNumber = getPRNumber(prUrl);
  return `- Update default CodeQL bundle version to [${cliVersion}](${bundleReleaseUrl}). [#${prNumber}](${prUrl})\n`;
}

function main() {
  try {
    const cliVersion = getCLIVersion();
    const prUrl = getPRUrl();

    // Include the CLI version in the file name so that changenotes for
    // different bundle updates don't conflict.
    const changenotePath = path.join(
      CHANGENOTES_DIR,
      `update-bundle-${cliVersion}.md`,
    );
    fs.writeFileSync(changenotePath, getChangenote(cliVersion, prUrl));

    return 0;
  } catch (err) {
    console.error(
      `Failed to create changenote for bundle update: ${getErrorMessage(err)}`,
    );
    return -1;
  }
}

// Only call `main` if this script was run directly.
if (import.meta.main) {
  process.exit(main());
}