reviewChangelogPrompt() — react Function Reference

Architecture documentation for the reviewChangelogPrompt() function in prepare-release.js from the react codebase.

Function javascript BabelCompiler Entrypoint called by 1

Entity Profile

BabelCompiler→ Entrypoint→ reviewChangelogPrompt() — react Function Reference

Dependency Diagram

graph TD
  06b9020a_d17b_440b_f05b_9db6724fd5be["reviewChangelogPrompt()"]
  497982e7_e1b1_28ad_fd0c_dc03591e3177["prepare-release.js"]
  06b9020a_d17b_440b_f05b_9db6724fd5be -->|defined in| 497982e7_e1b1_28ad_fd0c_dc03591e3177
  cadb4d3f_5109_b4e0_6f72_18067565caef["main()"]
  cadb4d3f_5109_b4e0_6f72_18067565caef -->|calls| 06b9020a_d17b_440b_f05b_9db6724fd5be
  style 06b9020a_d17b_440b_f05b_9db6724fd5be fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/devtools/prepare-release.js lines 204–222

async function reviewChangelogPrompt() {
  console.log('');
  console.log(
    'The changelog has been updated with commits since the previous release:'
  );
  console.log(`  ${chalk.bold(CHANGELOG_PATH)}`);
  console.log('');
  console.log('Please review the new changelog text for the following:');
  console.log('  1. Filter out any non-user-visible changes (e.g. typo fixes)');
  console.log('  2. Organize the list into Features vs Bugfixes');
  console.log('  3. Combine related PRs into a single bullet list');
  console.log(
    '  4. Replacing the "USERNAME" placeholder text with the GitHub username(s)'
  );
  console.log('');
  console.log(`  ${chalk.bold.green(`open ${CHANGELOG_PATH}`)}`);

  await confirmContinue();
}