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

Changelog doesn't include version header for workspace dependency bumps #2089

Closed
chrispcampbell opened this issue Sep 29, 2023 · 2 comments
Closed
Assignees
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@chrispcampbell
Copy link

Environment details

  • OS: Ubuntu 20.04 (GitHub Actions runner)
  • release-please version: 15.13.0 (via release-please-action v3.7.12)

Related issues

Note: This issue was mentioned in a later comment in related issue #1978, but I decided to file a separate issue for this changelog update problem because it seems separate from the other issues described in #1978, and maybe the fix is simpler for this one if done in isolation.

Steps to reproduce

See an example PR created by release-please in our SDEverywhere repo. This is a monorepo that uses the node-workspace plugin.

In this example, release-please created a PR that included 1 package that had a fix, and 2 packages that had a "workspace dependencies" version bump.

The changelog update for the compile package entry is correct and contains the version header:
image

However, the changelog updates for the other two packages are missing the version header:
image

Every time this happens I have to go in and manually edit the CHANGELOG.md files, otherwise the changelog becomes very confusing.

The release note entries in the PR summary are also missing the headers, but this is less of a problem for me than the missing entries in the CHANGELOG.md files.

In the following screenshot of the PR summary, note that the compile package entry is correct and contains the version header, but the cli and create entries are missing the version header. Additionally, those show up with the full package name (e.g., @sdeverywhere/create) while the compile package does not have the org prefix. (This is a minor detail and doesn't bother me as much, but still worth noting.)

image
@chrispcampbell chrispcampbell added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Sep 29, 2023
@chrispcampbell
Copy link
Author

This issue may have been resolved by PR #2112 (released in 16.6.0) but I won't be able to verify until there is a new release of release-please-action based on release-please >= 16.6.0.

I also just found another issue (#1530) that reports the same problem. That one can also be closed once we verify that the issue is resolved.

@chrispcampbell
Copy link
Author

Now that there is a new release-please-action (v4.0.3 and v4.1.0) that is using a newer version of release-please (v16.10.0), I verified that this issue has been resolved by PR #2112 (see my last comment). I will close this issue as fixed.

Here's a screenshot (of an SDEverywhere PR generated today) showing that a dependencies-only bump now has the correct version header in the changelog:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

No branches or pull requests

2 participants