[internal] Improve changelog generation script #2635
Conversation
oliviertassinari
added
type: regression
commit: |
✅ Deploy Preview for base-ui ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
oliviertassinari
force-pushed
the
improve-changelog-generation
branch
from
60dba7e to
04e4903
Compare
Bundle size report
|
| type ChangeScope = 'docs' | 'infra' | 'public-api' | 'internal' | 'dependencies' | 'release'; | ||
| type ChangelogEntryGroup = 'public-change-group-1' | 'internal-change'; |
There was a problem hiding this comment.
Rename "scope" to avoid confusion; it's not a product scope, it's more of a first level of grouping.
| ```diff | ||
| -onOpenChange: (open, event, reason) => { | ||
| +onOpenChange: (open, eventDetails) => { | ||
| - if (reason === 'escape-key') { | ||
| +onOpenChange: (open, eventDetails) => { | ||
| + if (eventDetails.reason === 'escape-key') { |
There was a problem hiding this comment.
The correct git diff output.
| changelogEntries.filter((entry) => entry.scope === 'public-api'), | ||
| format, | ||
| ); | ||
| const changesList = getFormattedChangelogEntries(changelogEntries, format); |
There was a problem hiding this comment.
Move the logic to as late as we need it, keeping top-level code about high-level flow control.
| prNumber, | ||
| author: commit.author, | ||
| group: getGroupFromLabels(labels), | ||
| components: getComponentsFromLabels(labels), |
There was a problem hiding this comment.
To scale the generation to cover other repositories, we would probably do a change like this:
| components: getComponentsFromLabels(labels), | |
| subGroups: getSubGroupsFromLabels(labels), |
subGroups can be components, but also an npm packages for a given change, so the current terminology would be a bit too narrow.
What's the benefit of this? From the users' perspective, Autocomplete and Combobox are two separate components. They are imported from different paths, and they have separate documentation pages. |
@michaldudak I will wait for what you guys want to do about points 4 and 6 in https://mui-org.slack.com/archives/C02P87NQLJC/p1757017036546399?thread_ts=1756997149.279849&cid=C02P87NQLJC to update the PR to match. It depends on the product scope labeling strategy picked for the combobox. |
Simplify the changelog generation after I broke it. Help with #2615:
And one potentially controversial change:
<Autocomplete>and<Combobox>at the same time (my experience with this in Material UI), so it's actually simpler to have one "scope: autocomplete" +componentlabels when we want to be more granular (not frequent).The alternative would be to: 1. remove this custom logic, 2. rename
component: Comboboxtoscope: combobox, and 3. renamecomponent: Autocompletetoscope: autocomplete.As far as I could test this PR, the generation is correct (relative to what we did for beta.3)
One step toward mui/mui-public#639