From 9e8de2aa94fd345b556542717e3ef8464150cc4a Mon Sep 17 00:00:00 2001 From: Rob Parrett Date: Mon, 7 Aug 2023 16:08:19 -0700 Subject: [PATCH] Slightly better message when contributor modifies examples template (#9372) # Objective Provide a slightly better message when a contributor needs to update the generated example readme file for [any number of reasons](https://github.com/bevyengine/bevy/pull/9372#discussion_r1285876202) but hasn't added any examples. This recently happened here: https://github.com/bevyengine/bevy/pull/9370#issuecomment-1666776092 The contributor modified the readme template and is being told that they added an example. ## Solution The advice given is still correct. Just change the message so that it's not accusing the contributor of adding an example. It may be possible to instead add more specific messages instead if someone is motivated to do that. edit: reworked this whole PR text --------- Co-authored-by: Nicola Papale --- .github/workflows/ci-comment-failures.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-comment-failures.yml b/.github/workflows/ci-comment-failures.yml index d8f5174c53a89..5a5506449f18d 100644 --- a/.github/workflows/ci-comment-failures.yml +++ b/.github/workflows/ci-comment-failures.yml @@ -117,7 +117,7 @@ jobs: owner: context.repo.owner, repo: context.repo.repo, issue_number: issue_number, - body: 'You added a new example but didn\'t update the readme. Please run `cargo run -p build-templated-pages -- update examples` to update it, and commit the file change.' + body: 'The generated `examples/README.md` is out of sync with the example metadata in `Cargo.toml` or the example readme template. Please run `cargo run -p build-templated-pages -- update examples` to update it, and commit the file change.' }); }