-
Notifications
You must be signed in to change notification settings - Fork 518
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
errant ### Dependencies
sections at the top of a number of CHANGELOG.md files
#2207
Comments
In a separate PR (#2234) I'm migrating Markdown linting to markdownlint-cli2. This change means updating from a 4y old markdown-lint. The new
For now I may just remove all those errant sections in that markdownlint-cli2 PR. They can be re-added with correct version h2 headers for this issue if someone is so motivated. |
…les found by rule MD001 (see open-telemetry#2207)
4733ea4 is the PR commit that removes these sections. |
As noticed in this PR review comment, a number of the CHANGELOG.md files in this repo have
### Dependencies
section incorrectly at the top, instead of under a particular release '## ...' h2 section.That last range (i.e. when it was "fixed") included #1901. A guess is that this bump resolved the issue:
symptoms
It looks like this resulted in the h2 header not being added for packages that only had a "Dependencies" section for that release. E.g. there was no
## [1.3.2](...)
section header added here: https://github.com/open-telemetry/opentelemetry-js-contrib/pull/1683/files#diff-40eb27dccbec82d0089702356abe45de22ff0b558e3668389a3d94782c8bc109trying to see what release-please change resulted in the fix
... and failing.
Looking at the timing of #1890 and #1935, matching to the tags on release-please-action.git (
v3.7.13...v4.0.2
) and to the included release-please.git versions (v15.13.0..v16.5.0
), nothing jumped out as an obviously related PR.fixing
A quick fix would to just drop all those
### Dependencies
sections and move on. It means that a number of older releases that only had deps updates will not have a changelog section.A longer fix would be to work through each of the following PRs and recreate the
## [${version}] ...
header for each package with an error and properly move that section down:The text was updated successfully, but these errors were encountered: