feat(core): programmatic API for nx release

[JamesHenry]

Current Behavior

nx release is intended for CLI usage only, and seamlessly stitching together version and changelog can be challenging.

Expected Behavior

There is a first-class programmatic API for all three nx release commands, and it is straightforward to create scripts which pass data through from version to changelog.

This will also make it much easier to create a meta CLI command in a follow up for easier adoption/smoother DX

---

Full example of how someone might build on top of this API:

import {
  releaseChangelog,
  releasePublish,
  releaseVersion,
} from "nx/src/command-line/release";
import * as yargs from 'yargs';

(async () => {
  const options = await yargs
    .version(false) // don't use the default meaning of version in yargs
    .option('version', {
      description:
        'Explicit version specifier to use, if overriding conventional commits',
      type: 'string',
    })
    .option('dryRun', {
      alias: 'd',
      description:
        'Whether or not to perform a dry-run of the release process, defaults to true',
      type: 'boolean',
      default: true,
    })
    .option('verbose', {
      description:
        'Whether or not to enable verbose logging, defaults to false',
      type: 'boolean',
      default: false,
    })
    .parseAsync();

  const { workspaceVersion, projectsVersionData } =
    await releaseVersion({
      specifier: options.version,
      // stage package.json updates to be committed later by the changelog command
      stageChanges: true,
      dryRun: options.dryRun,
      verbose: options.verbose,
    });

  await releaseChangelog({
    versionData: projectsVersionData,
    version: workspaceVersion,
    interactive: 'workspace',
    dryRun: options.dryRun,
    verbose: options.verbose,
  });

  await releasePublish({
    dryRun: options.dryRun,
    verbose: options.verbose,
  });

  process.exit(0);
})();

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Updated (UTC)
nx-dev	⬜️ Ignored (Inspect)	Visit Preview	Nov 23, 2023 8:21pm

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 2752baa. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 6 targets

• nx affected --target=e2e --base=db0f65e6a7ed4fa5c5834f66991aac0ada58c551 --head=2752baac64eddac653b0b63220cd6c19c25011f4 --parallel=1
• nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte
• nx affected --targets=lint,test,build --base=db0f65e6a7ed4fa5c5834f66991aac0ada58c551 --head=2752baac64eddac653b0b63220cd6c19c25011f4 --parallel=3
• nx-cloud record -- nx format:check --base=db0f65e6a7ed4fa5c5834f66991aac0ada58c551 --head=2752baac64eddac653b0b63220cd6c19c25011f4
• nx documentation --no-dte
• nx affected -t e2e-macos --parallel=1 --base=db0f65e6a7ed4fa5c5834f66991aac0ada58c551 --head=2752baac64eddac653b0b63220cd6c19c25011f4

---

Sent with 💌 from NxCloud.

[github-actions]

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.