[wiki] Include dependency upgrades in changelog #7177
Conversation
| ## When to write a changelog | ||
|
|
||
| Any updates to the `src/` folder require a new [upcoming changelog](../../../upcoming_changelogs/_template.md) file. Our release script handles collating upcoming changelog files into our main [CHANGELOG.md](../../../CHANGELOG.md) on new EUI versions. | ||
| - Any updates to the `src/` folder should include a changelog | ||
| - `dependency` upgrades in package.json should contain a changelog |
There was a problem hiding this comment.
I'd be curious to hear feedback from the team (and anyone outside as well) if there are other scenarios that we should more aggressively capture in our changelog, or if this is sufficient for now
There was a problem hiding this comment.
I think this is sufficient for now. This way, we define the rule (usually have a changelog), but in the section below, we give a few common instances where the rule may not apply. I think this is easier to abide by.
There was a problem hiding this comment.
I agree with @breehall. This feels clear and the information below highlights clear examples for PRs that do not need changelogs.
|
Thanks for the awesome and speedy feedback Bree! I'll leave this PR open another day to give other folks a chance to leave comments, but will look to merge sometime tomorrow if no further change requests |
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_7177/ |
💚 Build Succeeded
|
| ## When to write a changelog | ||
|
|
||
| Any updates to the `src/` folder require a new [upcoming changelog](../../../upcoming_changelogs/_template.md) file. Our release script handles collating upcoming changelog files into our main [CHANGELOG.md](../../../CHANGELOG.md) on new EUI versions. | ||
| - Any updates to the `src/` folder should include a changelog | ||
| - `dependency` upgrades in package.json should contain a changelog |
There was a problem hiding this comment.
I agree with @breehall. This feels clear and the information below highlights clear examples for PRs that do not need changelogs.
Summary
This process change is a direct result of elastic/kibana#163961 (comment), where confusion arose from a downstream snapshot change that resulted due to a dependency upgrade not listed in our changelog.
I've added a new section to our changelog template and yeoman generator for dependency upgrades specifically.
If we do want to list developer dependency updates in our changelog, it might be worth taking a leaf from, e.g.: https://github.com/hello-pangea/dnd/blob/main/CHANGELOG.md#1630-2023-06-30
QA
N/A, internal/dev-only