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.

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

Improve error messages when check-example-showcase-patches-still-work CI job fails #12539

Closed
alice-i-cecile opened this issue Mar 17, 2024 · 1 comment · Fixed by #12609
Closed
Labels
A-Build-System Related to build systems or continuous integration C-Usability A simple quality-of-life change that makes Bevy easier to use D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alice-i-cecile
Copy link
Member

alice-i-cecile commented Mar 17, 2024

I was slightly worried about contributor experience here. A failure currently looks like:

image
  • CI doesn't tell you which patch failed, so that needs to be cross-referenced
  • CI stops after the first failure

But with this running on merge_group, I guess it's mostly maintainers having to deal with / at least explain this to contributors?

Still, would something like this be helpful? (or maybe just a set -x)

CODE=0
for patch in tools/example-showcase/*.patch; do
  git apply --ignore-whitespace $patch || { echo "::error::$patch failed to apply."; CODE=1; }
done
exit $CODE

(output using that code here: https://github.com/rparrett/bevy/actions/runs/8286681390/job/22677245376#step:7:14)

Originally posted by @rparrett in #12457 (comment)

@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy A-Build-System Related to build systems or continuous integration C-Usability A simple quality-of-life change that makes Bevy easier to use labels Mar 17, 2024
@rparrett
Copy link
Contributor

Someone picking this up might also want to address this comment while they're in there. #12457 (comment)

github-merge-queue bot pushed a commit that referenced this issue Apr 22, 2024
# Objective

Fixes #12539

Improve [this CI
output](https://github.com/bevyengine/bevy/actions/runs/8367408952/job/22909715870#step:7:11).

## Solution

- Don't stop after the first failure.
- Print the filename of the patch(es) that failed.
- Clean up an unused package install while we're at it.

Tested over here: rparrett#20

---------

Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration C-Usability A simple quality-of-life change that makes Bevy easier to use D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants