-
Notifications
You must be signed in to change notification settings - Fork 612
Description
I think it is possible that lerna-changelog
, npm run changelog
, scripts/changelog-update.sh
, and the "changelog" entry in "package.json" might all be vestigial. release-please
handles changelog updates.
(FWIW, the CONTRIBUTING.md also refers to "RELEASING.md" which doesn't exist.)
Rabbit hole: I don't think either of these blocks of "changelog": ...
are used. I don't think lerna-changelog
is actually used anymore in this repo that I can tell, though I could be wrong.
The content added to the top-level "CHANGELOG.md" file used to use this npm run changelog
script I think -- its headers show signs of having used those header values. However, that CHANGELOG.md file is unused since 2022.
Now the new changelog content is in "packages/*/CHANGELOG.md" and those are updated by release-please
, e.g. this part of the last release PR: https://github.com/open-telemetry/opentelemetry-js-contrib/pull/3135/files#diff-5edc63adcef2085e5eea10b22f8d8ec1a026edeef5daa20799756bf8fcb165d2
Here is the distribution of those header values in the current set of CHANGELOG.md files:
% rg --no-filename '^### ' */CHANGELOG.md | rg -v github.com | sort | uniq -c |
sort -n
3 ### Performance Improvements
66 ### Miscellaneous Chores
140 ### ⚠ BREAKING CHANGES
999 ### Dependencies
1033 ### Bug Fixes
1225 ### Features
Those values match the set in release-please here:
- most of the values here: https://github.com/googleapis/release-please/blob/a9b82178ce8040af09e55be509911fa36e0c20e7/src/util/filter-commits.ts#L20-L32
### Dependencies
being handled separately here: https://github.com/googleapis/release-please/blob/a9b82178ce8040af09e55be509911fa36e0c20e7/src/plugins/workspace.ts#L486-L495BREAKING CHANGES
being handled separately here by a dep used by release-please: https://github.com/conventional-changelog/conventional-changelog/blob/1552de5434163eb63d3bf73d97bcb3bf34de8586/packages/conventional-changelog-conventionalcommits/src/writer.js#L90
tl;dr: I think we should clean up the changelog vestiges in a separate PR. Ideally this PR would not bother changing this part of lerna.json, so that it stays focused. However, I thikn it is fine and I just would like to merge this now.
Originally posted by @trentm in #3001 (comment)