build: Post pull request comments on build check failure #218
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fghaas
force-pushed
the
add-comments-on-pr
branch
from
a42802d to
b1a4f97
Compare
.github/workflows/comment.yml
Outdated
| # Post a comment back on a PR thread, in case an associated workflow | ||
| # failed. Note that comment-failure-action is a no-op in case the | ||
| # workflow was not invoked in response to a PR. In other words, this | ||
| # action only does creates a comments for workflows configured with |
There was a problem hiding this comment.
Suggested change
| # action only does creates a comments for workflows configured with | |
| # action only creates comments for workflows configured with |
Without this change, when a PR results in a build failure, the onus is on the PR submitter to find the failed build, and the corresponding build log. That is somewhat tedious and not particularly intuituive. Instead, use a separate GitHub Action that posts a comment back to the PR thread, containing a direct link to the failed build log. This should hopefully make it easier for PR submitters to find out what exactly their submitted change breaks. References: https://github.com/quipper/comment-failure-action/ quipper/comment-failure-action#6
fghaas
force-pushed
the
add-comments-on-pr
branch
from
b1a4f97 to
f283b50
Compare
|
Thanks for catching that; I've fixed that nit. Also, please note that this is one of those things that we can only actually test once they've landed in |
Makes sense, yes. |
fghaas
added a commit
to fghaas/cleura-docs
that referenced
this pull request
Aug 16, 2023
The workflow introduced in citynetwork#218, intended to facilitate pull requests by adding a comment in case the PR produced any build errors, failed on its first test. A build failure on citynetwork#217 did cause the action to fire, but it immediately failed with the following message: Run quipper/[email protected] No open pull requests found with packettoobig-patch-1 branch Since a pull request from that branch obviously did exist, it follows that the action isn't working as intended, so drop it and rely on per-user build notifications, set via https://github.com/settings/notifications, instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Without this change, when a PR results in a build failure, the onus is on the PR submitter to find the failed build, and the corresponding build log. That is somewhat tedious and not particularly intuituive.
Instead, use a separate GitHub Action that posts a comment back to the PR thread, containing a direct link to the failed build log. This should hopefully make it easier for PR submitters to find out what exactly their submitted change breaks.
Reference:
quipper/comment-failure-action#6