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

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

Closed
trentm opened this issue May 14, 2024 · 2 comments
Closed
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation priority:p4 Bugs and spec inconsistencies which do not fall into a higher prioritization

Comments

@trentm
Copy link
Contributor

trentm commented May 14, 2024

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:

@trentm trentm added the bug Something isn't working label May 14, 2024
@dyladan dyladan added documentation Improvements or additions to documentation priority:p4 Bugs and spec inconsistencies which do not fall into a higher prioritization labels May 15, 2024
@trentm
Copy link
Contributor Author

trentm commented May 23, 2024

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 npm run lint:markdown catches this errant ### Dependencies sections:

% npm run lint:markdown 2>&1 | rg MD001
detectors/node/opentelemetry-resource-detector-alibaba-cloud/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
detectors/node/opentelemetry-resource-detector-aws/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
detectors/node/opentelemetry-resource-detector-container/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
detectors/node/opentelemetry-resource-detector-gcp/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
detectors/node/opentelemetry-resource-detector-instana/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
metapackages/auto-instrumentations-node/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
metapackages/auto-instrumentations-web/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
packages/opentelemetry-propagation-utils/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/instrumentation-amqplib/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/instrumentation-lru-memoizer/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/instrumentation-mongoose/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/instrumentation-socket.io/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/instrumentation-tedious/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/opentelemetry-instrumentation-cassandra/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/opentelemetry-instrumentation-memcached/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/opentelemetry-instrumentation-mongodb/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/opentelemetry-instrumentation-mysql/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/opentelemetry-instrumentation-mysql2/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/opentelemetry-instrumentation-pg/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/opentelemetry-instrumentation-redis-4/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
plugins/node/opentelemetry-instrumentation-redis/CHANGELOG.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]

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.

trentm added a commit to trentm/opentelemetry-js-contrib that referenced this issue May 23, 2024
@trentm
Copy link
Contributor Author

trentm commented May 23, 2024

4733ea4 is the PR commit that removes these sections.

@trentm trentm self-assigned this May 30, 2024
@trentm trentm closed this as completed in 0078d0c May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation priority:p4 Bugs and spec inconsistencies which do not fall into a higher prioritization
Projects
None yet
Development

No branches or pull requests

2 participants