Skip to content

Commit

Permalink
Slightly better message when contributor modifies examples template (#…
Browse files Browse the repository at this point in the history
…9372)

# Objective

Provide a slightly better message when a contributor needs to update the
generated example readme file for [any number of
reasons](#9372 (comment))
but hasn't added any examples.

This recently happened here:
#9370 (comment)

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 <nicopap@users.noreply.github.com>
  • Loading branch information
rparrett and nicopap authored Aug 7, 2023
1 parent fe37ba5 commit 9e8de2a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/ci-comment-failures.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.'
});
}
Expand Down

0 comments on commit 9e8de2a

Please sign in to comment.