chore(workflows): run changelog check in CI for every public package
#9041
Conversation
acstll
added
the
skip-changelog
|
💡 This check is meant to be triggered by PRs. So a possible way to test it is simply basing a new branch off this one, and making appropriate changes:
maybe some other cases worth testing. |
Co-authored-by: Weronika Olejniczak <[email protected]>
Co-authored-by: Weronika Olejniczak <[email protected]>
to clean up workflow in changelog.yml
acstll
changed the title
changelog in CI for every public packagechangelog check in CI for every public package
|
|
||
| # Find all public packages and check for changes | ||
| public_packages=() | ||
| for dir in packages/*/; do |
There was a problem hiding this comment.
[Not a change request]
Yarn workspaces can technically have packages in different places than just the packages directory - they can be nested, or live somewhere else depending on configuration. The recommended approach would be to use yarn workspaces list --json and parse it like we do here - https://github.com/elastic/eui/blob/main/packages/release-cli/src/yarn_utils.ts#L19. However, for the purpose of this PR I don't consider this necessary
| set -e | ||
|
|
||
| # Get the list of changed files | ||
| changed_files=$(git diff --name-only origin/main...HEAD) |
There was a problem hiding this comment.
[Not a change request]
This could be simplified by relying on yarn's --since argument that lists packages changed since a specific ref (docs).
|
Thank you @weronikaolejniczak and @tkajtoch for reviewing this one! Merging… 🤞 |
3 participants
Summary
This PR updates the "Changelog required" workflow.
As of now, the check will pass if there's a changelog file present anywhere in
packages/*, regardless of the number of public packages that actually contain changes. This update makes sure the check in done for every public package that has changes.For example, the check will fail with "❌ Changelog file for PR # is missing in package 'eui-theme-borealis'" if:
euiandeui-theme-borealiseuiImportant
PR made with the help of AI, but carefully reviewed by a human (myself)
Why are we making this change?
To avoid issues while publishing packages, where a package expected to be published does not… (see #9007)
Resolves https://github.com/elastic/eui-private/issues/416
Impact to users
No impact, this is a change affecting only how the repo works.
QA
Do you know a good way to test this before actually merging? 😑