[Changelogs] Add check_changelogs bash script

[weronikaolejniczak]

Summary

• removed composite GH actions
• moved all "check changelogs" logic to a Bash script
• added support for per-package skips

Why are we making this change?

The current changelog job:

• can at times hang,
• takes a long time (compared to what it does),
• doesn't allow to skip the check for specific packages,
• the matrix strategy spins up several VMs for every single package changed, and there's an overhead for runners - downloading actions, checking out code for a task that takes ms to execute,
• it's not easy to test because the whole logic is dispersed throughout GH Action specific ✨ stuff ✨.

The proposed job:

• has all the logic in a separate Bash script and only executes the script, and passes appropriate GH context,
• it's easy to test because the Bash script can be launched in isolation from GH CI,
• supports per-package skips,
• runs in only one job, has less potential for hanging because the main job is not waiting for the response from matrix jobs.

Screenshots #

Impact to users

🟢 None. This is a CI change.

QA

Run the script:

# syntax
./scripts/check_changelogs.sh <PR_NUMBER> "<LABELS>"

# example
./scripts/check_changelogs.sh 1234 "bug|enhancement"

Make sure your fork is not stale:

git fetch && git checkout main && git rebase upstream/main

Testing scenarios

• the happy path
  • modify a public package: touch packages/eui/somefile.txt
  • create a dummy changelog: touch packages/eui/changelogs/upcoming/1234.md
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 ""
• the sad path
  • modify a public package: touch packages/eui/somefile.txt
  • don't create a changelog
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 ""
• global skip
  • modify a public package: touch packages/eui/somefile.txt
  • don't create a changelog
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 "skip-changelog"
• package-specific skip
  • modify a public package: touch packages/eui/somefile.txt
  • don't create a changelog
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 "skip-changelog-eui"
• private package ignored
  • modify a private package: touch packages/website/somefile.txt
  • don't create a changelog
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 ""
• no changes
  • run ./scripts/check_changelogs.sh 1234 ""
• mixed state
  • modify a public package: touch packages/eui/somefile.txt
  • modify a public package: touch packages/eui-theme-borealis/somefile.txt
  • modify a private package: touch packages/website/somefile.txt
  • add changelog only for one: touch packages/eui/changelogs/upcoming/1234.md
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 ""

[acstll]

this looks so much better than what we have currently! and with a fancy "+128 −130" balance, thank you @weronikaolejniczak 💚

I will do the grunty QA testing and scan the code! but it'd be nice if @tkajtoch could take a look as well

[acstll]

tested locally (in random order), at e558aed

working nicely as expected! 🟢

• the happy path
  • modify a public package: touch packages/eui/somefile.txt
  • create a dummy changelog: touch packages/eui/changelogs/upcoming/1234.md
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 ""
• the sad path
  • modify a public package: touch packages/eui/somefile.txt
  • don't create a changelog
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 ""
• global skip
  • modify a public package: touch packages/eui/somefile.txt
  • don't create a changelog
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 "skip-changelog"
• package-specific skip
  • modify a public package: touch packages/eui/somefile.txt
  • don't create a changelog
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 "skip-changelog-eui"
• private package ignored
  • modify a private package: touch packages/website/somefile.txt
  • don't create a changelog
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 ""
• no changes
  • run ./scripts/check_changelogs.sh 1234 ""
• mixed state
  • modify a public package: touch packages/eui/somefile.txt
  • modify a public package: touch packages/eui-theme-borealis/somefile.txt
  • modify a private package: touch packages/website/somefile.txt
  • add changelog only for one: touch packages/eui/changelogs/upcoming/1234.md
  • commit the changes
  • run ./scripts/check_changelogs.sh 1234 ""

[weronikaolejniczak]

Thank you, Arturo 🙏🏻 I appreciate your attention to detail 💚

[weronikaolejniczak]

@tkajtoch thank you for your suggestions, we shaved off 26 lines 💪🏻 I updated the fetch-depth to be 2, it scopes it to PR changes and makes CI much quicker (11s now). ubuntu-slim was a great tip to save on CI resources.

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: 97167c5
• Documentation website
• Storybook

History

• 💔 Build #2136 failed 94fba70
• 💔 Build #2134 failed 352b966
• 💔 Build #2133 failed 24e1247
• 💔 Build #2132 failed a4664ff
• 💚 Build #2111 succeeded 18caf09
• 💚 Build #2109 succeeded e558aed

cc @weronikaolejniczak

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: 97167c5

History

• 💔 Build #5367 failed 94fba70
• 💔 Build #5365 failed 352b966
• 💔 Build #5364 failed 24e1247
• 💔 Build #5363 failed a4664ff
• 💚 Build #5348 succeeded 18caf09
• 💚 Build #5346 succeeded e558aed

cc @weronikaolejniczak

[tkajtoch]

🎉

[tkajtoch]

The changes look great! Thanks for taking time to update the script