Changelog doesn't include version header for workspace dependency bumps #2089
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.
Environment details
release-please
version: 15.13.0 (viarelease-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:However, the changelog updates for the other two packages are missing the version header:
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 thecli
andcreate
entries are missing the version header. Additionally, those show up with the full package name (e.g.,@sdeverywhere/create
) while thecompile
package does not have the org prefix. (This is a minor detail and doesn't bother me as much, but still worth noting.)The text was updated successfully, but these errors were encountered: