Skip to content

errant ### Dependencies sections at the top of a number of CHANGELOG.md files #2207

Closed
@trentm

Description

@trentm

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.

  1. It was working up to and including: "chore: release main" (chore: release main #1590)
  2. then starting with this release PR it started incorrectly adding that section: "chore: release main" (chore: release main #1683)
  3. and continued for a number of releases, up to and including: "chore: release main" (chore: release main #1890)
  4. until fixed by the time this release PR was made: "chore: release main" (chore: release main #1935)

That last range (i.e. when it was "fixed") included #1901. A guess is that this bump resolved the issue:

-      - uses: google-github-actions/release-please-action@v3
+      - uses: google-github-actions/release-please-action@v4

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-40eb27dccbec82d0089702356abe45de22ff0b558e3668389a3d94782c8bc109

trying 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:

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentationpriority:p4Bugs and spec inconsistencies which do not fall into a higher prioritization

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions