Skip to content

feat(release): add breaking changes to release proposal#9196

Merged
pabloerhard merged 4 commits into
masterfrom
pabloerhard/release-proposal-update
Jul 2, 2026
Merged

feat(release): add breaking changes to release proposal#9196
pabloerhard merged 4 commits into
masterfrom
pabloerhard/release-proposal-update

Conversation

@pabloerhard

@pabloerhard pabloerhard commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Updates the release proposal generation flow to add a ### Breaking Changes section at the top of the release PR description when promoting a pre-release line to stable, such as 6.0.0-pre to 6.0.0.

For that promotion path, the script collects merged PRs labeled semver-major or only-land-on-next, filters them to PR numbers present in the included release/proposal commit history, and renders them before the regular release notes. This handles release branches built by cherry-picking, where the original GitHub merge commit SHA is not necessarily an ancestor of the release branch.

It also de-dupes regular release-note entries when the same PR is already listed as a breaking change.

Motivation

Breaking changes for a new major release are often merged before the release branch proposal is opened, or are guarded/backported in a way that makes branch-diff unable to identify them reliably.

The first stable promotion PR for a new major version should explicitly document those breaking changes, while stable patch/minor release proposals should not include a breaking changes section.

Additional Notes

  • The breaking changes section is only populated for pre-release promotion proposals.
  • Stable release paths continue to omit semver-major and only-land-on-next changes from normal release notes.
  • Added release changelog coverage for rendering and de-duping breaking entries.

Validation:

./node_modules/.bin/mocha "scripts/release/**/*.spec.js"

@dd-octo-sts

dd-octo-sts Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Overall package size

Self size: 6.52 MB
Deduped: 7.59 MB
No deduping: 7.59 MB

Dependency sizes | name | version | self size | total size | |------|---------|-----------|------------| | import-in-the-middle | 3.2.0 | 104.26 kB | 843.44 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | dc-polyfill | 0.1.11 | 25.74 kB | 25.74 kB |

🤖 This report was automatically generated by heaviest-objects-in-the-universe

@datadog-prod-us1-5

datadog-prod-us1-5 Bot commented Jul 2, 2026

Copy link
Copy Markdown

Tests

🎉 All green!

🧪 All tests passed
❄️ No new flaky tests detected

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 87.86% (+0.00%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 2e313a4 | Docs | Datadog PR Page | Give us feedback!

@pr-commenter

pr-commenter Bot commented Jul 2, 2026

Copy link
Copy Markdown

Benchmarks

Benchmark execution time: 2026-07-02 18:13:49

Comparing candidate commit 2e313a4 in PR branch pabloerhard/release-proposal-update with baseline commit f3c7006 in branch master.

📊 Benchmarking dashboard

Found 0 performance improvements and 0 performance regressions! Performance is the same for 2251 metrics, 35 unstable metrics.

Explanation

This is an A/B test comparing a candidate commit's performance against that of a baseline commit. Performance changes are noted in the tables below as:

  • 🟩 = significantly better candidate vs. baseline
  • 🟥 = significantly worse candidate vs. baseline

We compute a confidence interval (CI) over the relative difference of means between metrics from the candidate and baseline commits, considering the baseline as the reference.

If the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD), the change is considered significant.

Feel free to reach out to #apm-benchmarking-platform on Slack if you have any questions.

More details about the CI and significant changes

You can imagine this CI as a range of values that is likely to contain the true difference of means between the candidate and baseline commits.

CIs of the difference of means are often centered around 0%, because often changes are not that big:

---------------------------------(------|---^--------)-------------------------------->
                              -0.6%    0%  0.3%     +1.2%
                                 |          |        |
         lower bound of the CI --'          |        |
sample mean (center of the CI) -------------'        |
         upper bound of the CI ----------------------'

As described above, a change is considered significant if the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD).

For instance, for an execution time metric, this confidence interval indicates a significantly worse performance:

----------------------------------------|---------|---(---------^---------)---------->
                                       0%        1%  1.3%      2.2%      3.1%
                                                  |   |         |         |
       significant impact threshold --------------'   |         |         |
                      lower bound of CI --------------'         |         |
       sample mean (center of the CI) --------------------------'         |
                      upper bound of CI ----------------------------------'

Unstable benchmarks

These benchmarks have a confidence interval too wide to call a change; treat them as noise rather than signal.

scenario:appsec-appsec-enabled-20

  • unstable execution_time [-188724.333µs; +188405.233µs] or [-5.090%; +5.082%]

scenario:appsec-appsec-enabled-26

  • unstable execution_time [-205.143ms; +200.198ms] or [-8.155%; +7.958%]

scenario:appsec-appsec-enabled-with-attacks-26

  • unstable execution_time [-129.742ms; +174.179ms] or [-4.547%; +6.105%]

scenario:appsec-control-20

  • unstable execution_time [-155.697ms; +161.364ms] or [-8.882%; +9.205%]

scenario:appsec-control-24

  • unstable execution_time [-104229.236µs; +105399.903µs] or [-8.563%; +8.659%]

scenario:appsec-control-26

  • unstable execution_time [-110.645ms; +108.447ms] or [-9.176%; +8.994%]

scenario:debugger-line-probe-with-snapshot-default-24

  • unstable cpu_user_time [-461.206ms; +523.048ms] or [-5.641%; +6.397%]
  • unstable execution_time [-490.776ms; +551.950ms] or [-5.532%; +6.221%]
  • unstable instructions [-3649.1M instructions; +4259.8M instructions] or [-5.488%; +6.406%]
  • unstable throughput [-241.756op/s; +221.615op/s] or [-6.667%; +6.112%]

scenario:debugger-line-probe-with-snapshot-default-26

  • unstable cpu_user_time [-2.245s; +4.686s] or [-22.576%; +47.123%]
  • unstable execution_time [-2.301s; +4.772s] or [-21.601%; +44.787%]
  • unstable instructions [-19.4G instructions; +41.4G instructions] or [-23.420%; +49.923%]
  • unstable max_rss_usage [-6.563MB; +14.031MB] or [-4.072%; +8.706%]
  • unstable throughput [-1038.656op/s; +516.368op/s] or [-33.002%; +16.407%]

scenario:debugger-line-probe-with-snapshot-minimal-24

  • unstable cpu_user_time [-3661.516ms; +2520.077ms] or [-35.156%; +24.197%]
  • unstable execution_time [-3708.586ms; +2569.606ms] or [-33.411%; +23.150%]
  • unstable instructions [-31.0G instructions; +21.4G instructions] or [-36.172%; +24.884%]
  • unstable max_rss_usage [-14.792MB; +11.392MB] or [-8.954%; +6.896%]
  • unstable throughput [-674.401op/s; +1063.031op/s] or [-22.124%; +34.873%]

scenario:debugger-line-probe-with-snapshot-minimal-26

  • unstable cpu_user_time [-2205.911ms; +3325.570ms] or [-23.784%; +35.857%]
  • unstable execution_time [-2218.763ms; +3347.025ms] or [-22.256%; +33.574%]
  • unstable instructions [-19.6G instructions; +29.6G instructions] or [-25.289%; +38.170%]
  • unstable throughput [-732.778op/s; +508.002op/s] or [-22.215%; +15.400%]

scenario:debugger-line-probe-without-snapshot-26

  • unstable cpu_user_time [-2040.194ms; +3271.644ms] or [-21.716%; +34.824%]
  • unstable execution_time [-2052.197ms; +3292.782ms] or [-20.337%; +32.631%]
  • unstable instructions [-18.7G instructions; +29.5G instructions] or [-23.933%; +37.775%]
  • unstable max_rss_usage [-7.197MB; +10.759MB] or [-4.557%; +6.813%]
  • unstable throughput [-717.409op/s; +444.609op/s] or [-22.068%; +13.676%]

scenario:dogstatsd-with-tags-20

  • unstable cpu_user_time [-397.033ms; +315.120ms] or [-8.340%; +6.619%]
  • unstable execution_time [-401.156ms; +314.817ms] or [-8.296%; +6.511%]
  • unstable throughput [-105740.641op/s; +139539.505op/s] or [-6.089%; +8.036%]

scenario:plugin-graphql-long-with-depth-and-collapse-off-20

  • unstable max_rss_usage [-44.895MB; +76.821MB] or [-11.373%; +19.461%]

scenario:plugin-graphql-long-with-depth-off-20

  • unstable max_rss_usage [-9210.962KB; +7698.962KB] or [-7.163%; +5.988%]

scenario:test-optimization-large-suite-20

  • unstable max_rss_usage [-6.121MB; +2.741MB] or [-7.555%; +3.384%]

@codecov

codecov Bot commented Jul 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.64%. Comparing base (f3c7006) to head (2e313a4).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9196   +/-   ##
=======================================
  Coverage   93.64%   93.64%           
=======================================
  Files         898      898           
  Lines       52365    52365           
  Branches    12324    12324           
=======================================
  Hits        49037    49037           
  Misses       3328     3328           
Flag Coverage Δ
aiguard 34.88% <ø> (-0.08%) ⬇️
aiguard-integration 41.96% <ø> (ø)
apm-bucket-0 34.84% <ø> (-0.08%) ⬇️
apm-bucket-1 40.51% <ø> (-0.07%) ⬇️
apm-bucket-2 37.50% <ø> (-0.07%) ⬇️
apm-capabilities-tracing 48.88% <ø> (ø)
apm-integrations-aerospike 33.13% <ø> (-0.08%) ⬇️
apm-integrations-confluentinc-kafka-javascript 40.03% <ø> (-0.08%) ⬇️
apm-integrations-couchbase 33.41% <ø> (+0.08%) ⬆️
apm-integrations-http 42.05% <ø> (-0.07%) ⬇️
apm-integrations-kafkajs 40.27% <ø> (-0.08%) ⬇️
apm-integrations-next 29.59% <ø> (-0.11%) ⬇️
apm-integrations-prisma 35.18% <ø> (-0.07%) ⬇️
apm-integrations-tedious 34.05% <ø> (-0.08%) ⬇️
appsec 57.83% <ø> (-0.15%) ⬇️
appsec-express_fastify_graphql 53.85% <ø> (-0.04%) ⬇️
appsec-integration 35.68% <ø> (ø)
appsec-kafka_ldapjs_lodash 43.75% <ø> (-0.07%) ⬇️
appsec-mongodb-core_mongoose_mysql 48.91% <ø> (-0.06%) ⬇️
appsec-next 28.11% <ø> (-0.07%) ⬇️
appsec-node-serialize_passport_postgres 48.20% <ø> (+0.06%) ⬆️
appsec-sourcing_stripe_template 45.64% <ø> (-0.06%) ⬇️
debugger 44.64% <ø> (ø)
instrumentations-bucket-0 28.17% <ø> (-0.08%) ⬇️
instrumentations-bucket-1 37.57% <ø> (-0.07%) ⬇️
instrumentations-bucket-10 40.52% <ø> (-0.07%) ⬇️
instrumentations-bucket-11 27.96% <ø> (-0.08%) ⬇️
instrumentations-bucket-12 28.79% <ø> (-0.08%) ⬇️
instrumentations-bucket-13 27.79% <ø> (-0.08%) ⬇️
instrumentations-bucket-2 30.36% <ø> (-0.08%) ⬇️
instrumentations-bucket-3 36.06% <ø> (-0.08%) ⬇️
instrumentations-bucket-4 28.58% <ø> (-0.08%) ⬇️
instrumentations-bucket-5 36.42% <ø> (-0.07%) ⬇️
instrumentations-bucket-6 38.43% <ø> (-0.08%) ⬇️
instrumentations-bucket-7 36.16% <ø> (-0.07%) ⬇️
instrumentations-bucket-8 37.11% <ø> (-0.07%) ⬇️
instrumentations-bucket-9 39.62% <ø> (-0.07%) ⬇️
instrumentations-instrumentation-couchbase 46.48% <ø> (ø)
instrumentations-integration-esbuild 24.51% <ø> (ø)
llmobs-ai_anthropic_bedrock 39.68% <ø> (-0.07%) ⬇️
llmobs-google-genai_langchain_vertex-ai 37.10% <ø> (-0.06%) ⬇️
llmobs-openai 39.74% <ø> (-0.07%) ⬇️
llmobs-sdk 43.59% <ø> (-0.08%) ⬇️
master-coverage 93.64% <ø> (?)
openfeature 37.94% <ø> (+<0.01%) ⬆️
openfeature-unit 50.47% <ø> (ø)
platform-core_esbuild_instrumentations-misc 22.96% <ø> (ø)
platform-integration 47.59% <ø> (+0.01%) ⬆️
platform-shimmer_unit-guardrails_webpack 18.48% <ø> (ø)
plugins-bucket-0 36.52% <ø> (-0.07%) ⬇️
plugins-bucket-1 39.78% <ø> (ø)
plugins-bucket-11 38.63% <ø> (-0.08%) ⬇️
plugins-bucket-17 39.22% <ø> (-0.07%) ⬇️
plugins-bucket-18 42.17% <ø> (-0.07%) ⬇️
plugins-bucket-19 39.73% <ø> (-0.07%) ⬇️
plugins-bucket-20 43.46% <ø> (-0.05%) ⬇️
plugins-bucket-4 37.88% <ø> (-0.07%) ⬇️
plugins-bullmq_cassandra_cookie 39.93% <ø> (-0.07%) ⬇️
plugins-cookie-parser_crypto_dd-trace-api 33.23% <ø> (-0.08%) ⬇️
plugins-fetch_fs_generic-pool 36.21% <ø> (-0.08%) ⬇️
plugins-google-cloud-pubsub_grpc_handlebars 43.09% <ø> (-0.07%) ⬇️
plugins-hapi_hono_ioredis 37.96% <ø> (-0.06%) ⬇️
plugins-jest_knex_langgraph 32.61% <ø> (-0.08%) ⬇️
plugins-ldapjs_light-my-request_limitd-client 27.92% <ø> (-0.02%) ⬇️
plugins-lodash_mariadb_memcached 35.18% <ø> (-0.08%) ⬇️
plugins-mongodb_mongodb-core_mongoose 36.46% <ø> (-0.07%) ⬇️
plugins-multer_mysql_mysql2 35.15% <ø> (-0.08%) ⬇️
plugins-nats_node-serialize_opensearch 37.25% <ø> (-0.13%) ⬇️
plugins-passport-http_pino_postgres 35.63% <ø> (+0.01%) ⬆️
plugins-process_pug_redis 34.27% <ø> (-0.08%) ⬇️
plugins-undici_url_valkey 36.04% <ø> (-0.07%) ⬇️
plugins-vm_winston_ws 37.72% <ø> (-0.08%) ⬇️
profiling 43.81% <ø> (-0.07%) ⬇️
serverless-aws-sdk-aws-sdk 33.32% <ø> (-0.07%) ⬇️
serverless-aws-sdk-bedrockruntime 32.19% <ø> (-0.07%) ⬇️
serverless-aws-sdk-client 37.16% <ø> (ø)
serverless-aws-sdk-dynamodb 34.19% <ø> (-0.07%) ⬇️
serverless-aws-sdk-eventbridge 27.36% <ø> (-0.07%) ⬇️
serverless-aws-sdk-kinesis 37.55% <ø> (-0.07%) ⬇️
serverless-aws-sdk-lambda 34.64% <ø> (-0.07%) ⬇️
serverless-aws-sdk-s3 32.63% <ø> (-0.07%) ⬇️
serverless-aws-sdk-serverless-peer-service 39.65% <ø> (-0.08%) ⬇️
serverless-aws-sdk-sns 38.40% <ø> (-0.07%) ⬇️
serverless-aws-sdk-sqs 38.14% <ø> (-0.07%) ⬇️
serverless-aws-sdk-stepfunctions 33.22% <ø> (-0.07%) ⬇️
serverless-aws-sdk-util 47.95% <ø> (ø)
serverless-bucket-0 39.64% <ø> (ø)
serverless-lambda 34.34% <ø> (-0.09%) ⬇️
test-optimization-cucumber 52.54% <ø> (+0.11%) ⬆️
test-optimization-cypress 49.63% <ø> (+0.06%) ⬆️
test-optimization-jest 55.57% <ø> (+0.04%) ⬆️
test-optimization-mocha 53.61% <ø> (+0.08%) ⬆️
test-optimization-playwright-playwright-atr 43.53% <ø> (+0.08%) ⬆️
test-optimization-playwright-playwright-efd 44.03% <ø> (+0.30%) ⬆️
test-optimization-playwright-playwright-final-status 43.94% <ø> (+0.11%) ⬆️
test-optimization-playwright-playwright-impacted-tests 43.36% <ø> (ø)
test-optimization-playwright-playwright-reporting 43.47% <ø> (+0.08%) ⬆️
test-optimization-playwright-playwright-test-management 44.93% <ø> (+0.08%) ⬆️
test-optimization-playwright-playwright-test-span 44.72% <ø> (+0.07%) ⬆️
test-optimization-selenium 45.44% <ø> (+0.06%) ⬆️
test-optimization-testopt 46.82% <ø> (+0.08%) ⬆️
test-optimization-vitest 52.73% <ø> (+0.11%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pabloerhard pabloerhard changed the title add breaking changes to release proposal feat(release): add breaking changes to release proposal Jul 2, 2026
rochdev
rochdev previously approved these changes Jul 2, 2026
@pabloerhard
pabloerhard marked this pull request as ready for review July 2, 2026 17:47
@pabloerhard
pabloerhard requested a review from a team as a code owner July 2, 2026 17:47

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 153fd55f11

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread scripts/release/proposal.js Outdated

for (const pullRequest of pullRequests) {
const oid = pullRequest.mergeCommit?.oid
if (!oid || (!isAncestor(oid, `v${releaseLine}.x`) && !isAncestor(oid, upperBoundRef))) continue

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Include breaking PRs already cherry-picked to the release line

When the pre-release branch is already caught up through earlier proposal runs, allMainShas is empty and upperBoundRef falls back to v${releaseLine}.x; because this script populates release branches with git cherry-pick, the GitHub PR mergeCommit.oid is usually not an ancestor of that branch even though the change is present under a different SHA. This check then filters out those semver-major/only-land-on-next PRs, so the final stable promotion can generate no ### Breaking Changes entries for changes that were already cherry-picked into the release line.

Useful? React with 👍 / 👎.

@pabloerhard
pabloerhard merged commit 24cd2f3 into master Jul 2, 2026
876 of 879 checks passed
@pabloerhard
pabloerhard deleted the pabloerhard/release-proposal-update branch July 2, 2026 18:25
dd-octo-sts Bot pushed a commit that referenced this pull request Jul 2, 2026
* add breaking changes to release proposal

* fetch from master instead

* removes stable path fallback

* fix wrong look up
@dd-octo-sts dd-octo-sts Bot mentioned this pull request Jul 2, 2026
dd-octo-sts Bot pushed a commit that referenced this pull request Jul 2, 2026
* add breaking changes to release proposal

* fetch from master instead

* removes stable path fallback

* fix wrong look up
@dd-octo-sts dd-octo-sts Bot mentioned this pull request Jul 2, 2026
rochdev pushed a commit that referenced this pull request Jul 2, 2026
* add breaking changes to release proposal

* fetch from master instead

* removes stable path fallback

* fix wrong look up
rochdev pushed a commit that referenced this pull request Jul 2, 2026
* add breaking changes to release proposal

* fetch from master instead

* removes stable path fallback

* fix wrong look up
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants