Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[wiki] Include dependency upgrades in changelog #7177

Merged
merged 3 commits into from
Sep 12, 2023
Merged

[wiki] Include dependency upgrades in changelog #7177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72757f6
Add `dependency updates` as specific changelog entry/section
cee-chen Sep 11, 2023
d9063aa
Update changelog wiki doc
cee-chen Sep 11, 2023
7a9a216
Update wiki/contributing-to-eui/documenting/changelogs.md
cee-chen Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions generator-eui/changelog/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ module.exports = class extends Generator {
type: 'confirm',
default: false,
},
{
message: 'Does your PR contain dependency updates?',
name: 'dependencyUpdates',
type: 'confirm',
default: false,
},
];

return this.prompt(prompts).then((answers) => {
Expand Down
5 changes: 5 additions & 0 deletions generator-eui/changelog/templates/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,8 @@

- Converted `EuiComponent` to Emotion; Removed `$euiComponentSassVariable`
<%_ } -%>
<%_ if (dependencyUpdates) { -%>
**Dependency updates**

- Updated `dependency` to v10.20.30
<%_ } -%>
4 changes: 4 additions & 0 deletions upcoming_changelogs/_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,7 @@
**CSS-in-JS conversions**

- Converted `EuiComponent` to Emotion; Removed `$euiComponentSassVariable`

**Dependency updates**

- Updated `dependency` to v10.20.30
12 changes: 10 additions & 2 deletions wiki/contributing-to-eui/documenting/changelogs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# Changelogs

All upcoming changelogs should go into the [upcoming_changelogs/](../../../upcoming_changelogs/_template.md) directory. Our release script automatically handles collating these files into our main [CHANGELOG.md](../../../CHANGELOG.md) on new EUI versions.

## 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
Comment on lines 5 to +8
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with @breehall. This feels clear and the information below highlights clear examples for PRs that do not need changelogs.


## When to skip a changelog

Changes that do not impact consumers or end-users (e.g. documentation-only changes to `wiki/` or `src-docs/`) or infra/dev-only changes (e.g. changes to `.github/` or `scripts/`) do not require a changelog entry. You may use the `skip-changelog` label on your PR to bypass CI checks.
Changes that do not impact consumers or end-users may use the `skip-changelog` label on PRs to bypass CI checks. Examples of these types of changes:

- Documentation-only changes (e.g. changes to `wiki/` or `src-docs/`)
- Infra/dev-only changes (e.g. changes to `.github/` or `scripts/`)
- Test-only changes (e.g. changes to `*.test.tsx`, `*.spec.tsx`, or `*.stories.tsx` files)
- `dev-dependency` upgrades in package.json
cee-chen marked this conversation as resolved.
Show resolved Hide resolved

## How to write a changelog

Expand Down
Loading