Skip to content

📝 Add DO NOT MODIFY IT BY HAND comment to CHANGELOG.md#4526

Merged
thomas-lebeau merged 2 commits intomainfrom
valentin.pertuisot/changelog-do-not-modify-comment
May 4, 2026
Merged

📝 Add DO NOT MODIFY IT BY HAND comment to CHANGELOG.md#4526
thomas-lebeau merged 2 commits intomainfrom
valentin.pertuisot/changelog-do-not-modify-comment

Conversation

@Valpertui
Copy link
Copy Markdown
Member

Motivation

CHANGELOG.md is generated automatically during the release process, but nothing in the file itself signals this to contributors (or coding agents). This can lead to accidental manual edits that get overwritten on the next release.

Changes

Added an HTML comment at the top of CHANGELOG.md marking it as auto-generated:

<!-- DO NOT MODIFY IT BY HAND. This file is generated automatically during the release process. -->

This aligns with the existing "Auto-Generated Files" rule in AGENTS.md, which instructs contributors to respect DO NOT MODIFY IT BY HAND headers — now CHANGELOG.md carries that header too.

Test instructions

Visual check of the diff — no runtime impact.

Checklist

  • Tested locally
  • Tested on staging
  • Added unit tests for this change.
  • Added e2e/integration tests for this change.
  • Updated documentation and/or relevant AGENTS.md file

🤖 Generated with Claude Code

The file is generated automatically during the release process.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Valpertui Valpertui requested a review from a team as a code owner April 24, 2026 09:31
Copy link
Copy Markdown

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

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: 3151e712db

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread CHANGELOG.md
The generator template started fresh from '# Changelog' and sliced
previousContent from the first '\n##', which would drop the
DO NOT MODIFY IT BY HAND comment on the next release. Emit it from the
template so the warning survives regeneration.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@cit-pr-commenter-54b7da
Copy link
Copy Markdown

cit-pr-commenter-54b7da Bot commented Apr 24, 2026

Bundles Sizes Evolution

📦 Bundle Name Base Size Local Size 𝚫 𝚫% Status
Rum 179.27 KiB 179.27 KiB 0 B 0.00%
Rum Profiler 6.16 KiB 6.16 KiB 0 B 0.00%
Rum Recorder 27.03 KiB 27.03 KiB 0 B 0.00%
Logs 56.65 KiB 56.65 KiB 0 B 0.00%
Rum Slim 135.11 KiB 135.11 KiB 0 B 0.00%
Worker 23.63 KiB 23.63 KiB 0 B 0.00%
🚀 CPU Performance
Action Name Base CPU Time (ms) Local CPU Time (ms) 𝚫%
RUM - add global context 0.0042 0.0048 +14.29%
RUM - add action 0.0145 0.0157 +8.28%
RUM - add error 0.0125 0.0142 +13.60%
RUM - add timing 0.0029 0.0026 -10.34%
RUM - start view 0.0131 0.0131 0.00%
RUM - start/stop session replay recording 0.0007 0.0008 +14.29%
Logs - log message 0.0155 0.0182 +17.42%
🧠 Memory Performance
Action Name Base Memory Consumption Local Memory Consumption 𝚫
RUM - add global context 30.86 KiB 31.94 KiB +1.09 KiB
RUM - add action 104.43 KiB 95.16 KiB -9.27 KiB
RUM - add timing 33.36 KiB 32.93 KiB -442 B
RUM - add error 97.64 KiB 111.47 KiB +13.82 KiB
RUM - start/stop session replay recording 32.49 KiB 31.95 KiB -554 B
RUM - start view 488.94 KiB 495.33 KiB +6.39 KiB
Logs - log message 104.78 KiB 98.00 KiB -6.78 KiB

🔗 RealWorld

@datadog-prod-us1-5
Copy link
Copy Markdown

datadog-prod-us1-5 Bot commented Apr 24, 2026

Tests

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 77.01% (-0.01%)

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

const changeLists = getChangeLists()

return `\
<!-- DO NOT MODIFY IT BY HAND. This file is generated automatically during the release process. -->
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

minor

since this text is static, I would suggest moving it to constants.ts for consistency

@thomas-lebeau thomas-lebeau merged commit a46f952 into main May 4, 2026
21 checks passed
@thomas-lebeau thomas-lebeau deleted the valentin.pertuisot/changelog-do-not-modify-comment branch May 4, 2026 09:49
@github-actions github-actions Bot locked and limited conversation to collaborators May 4, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants