♻️ [RUM-159] Categorize changes as public or internal in the CHANGELOG #2851

RomanGaignault · 2024-07-09T12:24:54Z

Motivation

When we created the CHANGELOG, we chose to only show public changes (bug fixes, new features, …).

In practice, this is not always respected. Sometimes, it’s not clear whether it is a public or internal change. We are a bit hesitant to show experimental features or not. Sometimes we do releases with only internal changes, and having an empty entry is not ideal.

Changes

Let’s add everything, but to help the reading, split changes into two sections (ex: public/internal changes). The generate_changelog script should handle the formating based on gitmojis.

Testing

Local
Staging
Unit
End to end

I have gone over the contributing documentation.

codecov-commenter · 2024-07-09T12:26:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.64%. Comparing base (30ae145) to head (51a8e2b).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2851      +/-   ##
==========================================
- Coverage   93.66%   93.64%   -0.02%     
==========================================
  Files         266      266              
  Lines        7573     7573              
  Branches     1683     1683              
==========================================
- Hits         7093     7092       -1     
- Misses        480      481       +1

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

cit-pr-commenter · 2024-07-09T12:37:19Z

Bundles Sizes Evolution

📦 Bundle Name	Base Size	Local Size	𝚫%	Status
Rum	161.37 KiB	161.37 KiB	0.00%	✅
Logs	57.97 KiB	57.97 KiB	0.00%	✅
Rum Slim	109.89 KiB	109.89 KiB	0.00%	✅
Worker	25.21 KiB	25.21 KiB	0.00%	✅

🚀 CPU Performance

Action Name	Base Average Cpu Time (ms)	Local Average Cpu Time (ms)	𝚫
addglobalcontext	0.002	0.002	0.000
addaction	0.034	0.045	0.011
adderror	0.051	0.034	-0.017
addtiming	0.001	0.001	0.000
startview	1.230	1.052	-0.179
startstopsessionreplayrecording	0.906	0.992	0.085
logmessage	0.023	0.022	-0.001

🧠 Memory Performance

Action Name	Base Consumption Memory (bytes)	Local Consumption Memory (bytes)	𝚫 (bytes)
addglobalcontext	22.05 KiB	20.95 KiB	-1130 B
addaction	73.70 KiB	73.82 KiB	123 B
adderror	88.13 KiB	87.42 KiB	-727 B
addtiming	19.17 KiB	18.72 KiB	-461 B
startview	333.58 KiB	351.22 KiB	17.63 KiB
startstopsessionreplayrecording	16.50 KiB	15.68 KiB	-839 B
logmessage	71.05 KiB	72.79 KiB	1.74 KiB

🔗 RealWorld

scripts/release/generate-changelog.js

amortemousque · 2024-07-11T07:21:55Z

scripts/release/generate-changelog.js

-const START_WITH_EMOJI = /^\p{Emoji_Presentation}/u
-
+const PUBLIC_EMOJI_PRIORITY = ['💥', '✨', '🐛', '⚡️', '📝', '⚗️']
+const INTERNAL_EMOJI_PRIORITY = ['👷', '🎨', '🧪', '✅', '👌', '♻️', '🔧', '📄', '🔇', '🔊', '📦']


🥜 nitpick: ‏I would reorder the table to put the emojis of the same "nature" close to one another:

['👷', '🔧', '📦', // build conf‏ '♻️', '🎨', // refactoring '🧪', '✅', // tests '🔇', '🔊', // telemetry '👌', '📄']

RomanGaignault · 2024-07-11T18:47:28Z

/to-staging

dd-devflow · 2024-07-11T18:47:34Z

🚂 Branch Integration: starting soon, median merge time is 11m

Commit 51a8e2be4b will soon be integrated into staging-28.

Use /to-staging -c to cancel this operation!

) into staging-28 Integrated commit sha: 51a8e2b Co-authored-by: roman.gaignault <[email protected]>

dd-devflow · 2024-07-11T18:59:57Z

🚂 Branch Integration: This commit was successfully integrated

Commit 51a8e2be4b has been merged into staging-28 in merge commit 21eb08f0d0.

Check out the triggered pipeline on Gitlab 🦊

BenoitZugmeyer · 2024-07-15T10:31:00Z

scripts/release/generate-changelog.js

+${internalChanges.join('\n')}
+`.replace(/\(#(\d+)\)/gm, (_, id) => `([#${id}](https://github.com/DataDog/browser-sdk/pull/${id}))`)


❓ question: ‏this is nice, but why is it done only for internal changes?

Thanks ! What do you mean only for internal changes ? it's replacing for internal and public I guess

Ah sorry I misread! Looks fine then.

BenoitZugmeyer · 2024-07-15T10:43:21Z

scripts/release/generate-changelog.js

-
+const CHANGELOG_FILE = '../../CHANGELOG.md'
+const CONTRIBUTING_FILE = '../../CONTRIBUTING.md'
+const PUBLIC_EMOJI_PRIORITY = ['💥', '✨', '🐛', '⚡️', '📝', '⚗️']


⚠️ The ⚡️ emoji in that list is incorrect. It's encoded as '\u26a1\ufe0f' but should be only '\u26a1'

good catch 👍 I will update this in the next Pr

BenoitZugmeyer · 2024-07-15T10:55:57Z

scripts/release/generate-changelog.js

-
+const CHANGELOG_FILE = '../../CHANGELOG.md'
+const CONTRIBUTING_FILE = '../../CONTRIBUTING.md'
+const PUBLIC_EMOJI_PRIORITY = ['💥', '✨', '🐛', '⚡️', '📝', '⚗️']


💭 thought: ‏'⚗️' should be internal I think

RomanGaignault added 2 commits July 9, 2024 14:22

added link to changelog and added internal or public changes category

e11feb1

change path files

eba8fbd

RomanGaignault added 2 commits July 9, 2024 14:26

delete console log

b5ee8a9

change path

c642603

RomanGaignault marked this pull request as ready for review July 9, 2024 12:30

RomanGaignault requested a review from a team as a code owner July 9, 2024 12:30

amortemousque reviewed Jul 10, 2024

View reviewed changes

scripts/release/generate-changelog.js Outdated Show resolved Hide resolved

nulrich reviewed Jul 10, 2024

View reviewed changes

scripts/release/generate-changelog.js Outdated Show resolved Hide resolved

RomanGaignault changed the title ~~♻️ [RUM-159] Include internal changes in the CHANGELOG~~ ♻️ [RUM-159] Categorize changes as public or internal in the CHANGELOG Jul 10, 2024

update sorting and emojies

7eb806c

amortemousque reviewed Jul 11, 2024

View reviewed changes

amortemousque approved these changes Jul 11, 2024

View reviewed changes

update emoji order

51a8e2b

N-Boutaib approved these changes Jul 11, 2024

View reviewed changes

nulrich approved these changes Jul 11, 2024

View reviewed changes

dd-mergequeue bot added a commit that referenced this pull request Jul 11, 2024

Integrate roman/RUM-159-include-internal-changes-in-the-changelog (#2851

21eb08f

) into staging-28 Integrated commit sha: 51a8e2b Co-authored-by: roman.gaignault <[email protected]>

dd-devflow bot added the staging-28 label Jul 11, 2024

RomanGaignault merged commit 91c814e into main Jul 11, 2024
21 checks passed

RomanGaignault deleted the roman/RUM-159-include-internal-changes-in-the-changelog branch July 11, 2024 23:47

BenoitZugmeyer reviewed Jul 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

♻️ [RUM-159] Categorize changes as public or internal in the CHANGELOG #2851

♻️ [RUM-159] Categorize changes as public or internal in the CHANGELOG #2851

RomanGaignault commented Jul 9, 2024 •

edited

Loading

codecov-commenter commented Jul 9, 2024 •

edited

Loading

cit-pr-commenter bot commented Jul 9, 2024 •

edited

Loading

amortemousque Jul 11, 2024

RomanGaignault commented Jul 11, 2024

dd-devflow bot commented Jul 11, 2024

dd-devflow bot commented Jul 11, 2024

BenoitZugmeyer Jul 15, 2024

RomanGaignault Jul 15, 2024

BenoitZugmeyer Jul 15, 2024

BenoitZugmeyer Jul 15, 2024

RomanGaignault Jul 15, 2024

BenoitZugmeyer Jul 15, 2024

		${internalChanges.join('\n')}
		`.replace(/\(#(\d+)\)/gm, (_, id) => `([#${id}](https://github.com/DataDog/browser-sdk/pull/${id}))`)

♻️ [RUM-159] Categorize changes as public or internal in the CHANGELOG #2851

♻️ [RUM-159] Categorize changes as public or internal in the CHANGELOG #2851

Conversation

RomanGaignault commented Jul 9, 2024 • edited Loading

Motivation

Changes

Testing

codecov-commenter commented Jul 9, 2024 • edited Loading

Codecov Report

cit-pr-commenter bot commented Jul 9, 2024 • edited Loading

Bundles Sizes Evolution

amortemousque Jul 11, 2024

Choose a reason for hiding this comment

RomanGaignault commented Jul 11, 2024

dd-devflow bot commented Jul 11, 2024

dd-devflow bot commented Jul 11, 2024

BenoitZugmeyer Jul 15, 2024

Choose a reason for hiding this comment

RomanGaignault Jul 15, 2024

Choose a reason for hiding this comment

BenoitZugmeyer Jul 15, 2024

Choose a reason for hiding this comment

BenoitZugmeyer Jul 15, 2024

Choose a reason for hiding this comment

RomanGaignault Jul 15, 2024

Choose a reason for hiding this comment

BenoitZugmeyer Jul 15, 2024

Choose a reason for hiding this comment

RomanGaignault commented Jul 9, 2024 •

edited

Loading

codecov-commenter commented Jul 9, 2024 •

edited

Loading

cit-pr-commenter bot commented Jul 9, 2024 •

edited

Loading