Function generateChangelogContent

scripts/changes/changes.ts:509–595

(
  release: PackageRelease,
  options: {
    /** Whether to include package name in heading. Default: false */
    includePackageName?: boolean;
    /** Whether to include the date in heading. Default: false */
    includeDate?: boolean;
    /** Markdown heading level (2 = ##, 3 = ###). Default: 2 */
    headingLevel?: 2 | 3;
    /** Optional footer to append at the end */
    footerLines?: string[];
    /** Optional "What's Changed" section to include before generated change sections */
    whatsChanged?: string;
    /** Whether to skip sorting changes (for root changelog generation). Default: false */
    skipSort?: boolean;
  } = {},
)

 * Generates changelog content for a package release
 */
export function generateChangelogContent(
  release: PackageRelease,
  options: {
    /** Whether to include package name in heading. Default: false */
    includePackageName?: boolean;
    /** Whether to include the date in heading. Default: false */
    includeDate?: boolean;
    /** Markdown heading level (2 = ##, 3 = ###). Default: 2 */
    headingLevel?: 2 | 3;
    /** Optional footer to append at the end */
    footerLines?: string[];
    /** Optional "What's Changed" section to include before generated change sections */
    whatsChanged?: string;
    /** Whether to skip sorting changes (for root changelog generation). Default: false */
    skipSort?: boolean;
  } = {},
): string {
  let { includePackageName = false, headingLevel = 2 } = options;
  let lines: string[] = [];

  let headingPrefix = "#".repeat(headingLevel);
  let packagePart = includePackageName ? `${release.packageName} ` : "";
  lines.push(`${headingPrefix} ${packagePart}v${release.nextVersion}`);
  lines.push("");

  if (options.includeDate) {
    let now = new Date();
    // Generate a YYYY-MM-DD date for the local timezone, not GMT
    let dateStr = new Date(
      now.getFullYear(),
      now.getMonth(),
      now.getDate(),
      now.getHours() - now.getTimezoneOffset() / 60,
    )
      .toISOString()
      .substring(0, 10);
    lines.push(`Date: ${dateStr}`);
    lines.push("");
  }

  let subheadingLevel = headingLevel + 1;

  if (options.whatsChanged) {
    lines.push(options.whatsChanged.trim());
    lines.push("");
  }

  // Generate sections in order: major, minor, patch (skipping empty sections)
  for (let bumpType of bumpTypes) {
    let section = generateBumpTypeSection(
      release.changes,
      bumpType,
      subheadingLevel,
      { skipSort: options.skipSort },
    );
    if (section) {
      lines.push(section);
    }