feat(release)!: releasePublish always returns status code per project

[JamesHenry]

BREAKING CHANGE

In v19 of nx, the programmatic usage of await releasePublish({ ... }) would throw in the case that any project failed to publish. It would return the number 0 (to represent the overall exit code) in the case that all projects were successfully published.

Now, in v20, the programmatic usage of await releasePublish({ ... }) will always return a PublishProjectsResult object, which is a mapping of project names to an object of { code: number } for each project. This allows consumers to make informed decisions about which projects failed to publish and decide how to handle it in their release scripts.

For example, where there are projects called "pkg-a" and "pkg-b" and "pkg-a" is successfully published and "pkg-b" fails:

const result = await releasePublish({
  dryRun: false
});
// result is set to { "pkg-a": { code: 0 }, "pkg-b": { code: 1 } )

[vercel]

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

1 Skipped Deployment

Name	Status	Preview	Updated (UTC)
nx-dev	⬜️ Ignored (Inspect)	Visit Preview	Oct 1, 2024 2:58pm

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit ef25d35. 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 4 targets

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

---

Sent with 💌 from NxCloud.

[JamesHenry]

This never actually did anything after the throw was added at some point

[JamesHenry]

This never actually did anything after the throw was added at some point

[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.