Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(release): version plan changelogs should contain authors and refs #27737

Merged
merged 2 commits into from
Sep 3, 2024

Conversation

JamesHenry
Copy link
Collaborator

@JamesHenry JamesHenry commented Sep 3, 2024

Current Behavior

  • Version plan changelogs do not extract and render issue/PR/commit references from git data
  • Version plan changelogs do not extract author references from git data
  • Version plan changelogs always repeat project scopes leading to noise
  • Version plan changelogs handle breaking changes in the same way as conventional commits which looks wonky for that use-case
  • (Also addresses versioning edge case in pnpm where a locally linked package can have no version field at all)

Expected Behavior

Git commit data is now fully resolved for version plan files and whether or not version plans are in use is taken into account in the default changelog renderer to allow for rendering git/github references, authors and custom handling of breaking changes.

Related Issue(s)

Fixes #

Copy link

vercel bot commented Sep 3, 2024

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 Sep 3, 2024 0:33am

@JamesHenry JamesHenry marked this pull request as ready for review September 3, 2024 13:04
@JamesHenry JamesHenry requested review from a team as code owners September 3, 2024 13:04
Copy link

github-actions bot commented Sep 3, 2024

🐳 We have a release for that!

This PR has a release associated with it. You can try it out using this command:

npx create-nx-workspace@0.0.0-pr-27737-f2311b5 my-workspace

Or just copy this version and use it in your own command:

0.0.0-pr-27737-f2311b5
Release details 📑
Published version 0.0.0-pr-27737-f2311b5
Triggered by @JamesHenry
Branch version-plan-changelog-improvements
Commit f2311b5
Workflow run 10683242679

To request a new release for this pull request, mention someone from the Nx team or the @nrwl/nx-pipelines-reviewers.

@JamesHenry JamesHenry merged commit 7171536 into master Sep 3, 2024
6 checks passed
@JamesHenry JamesHenry deleted the version-plan-changelog-improvements branch September 3, 2024 13:11
FrozenPandaz pushed a commit that referenced this pull request Sep 3, 2024
Copy link

github-actions bot commented Sep 9, 2024

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants