Auto-comment on PR template CI failure #10015
Conversation
| return; | ||
| } | ||
|
|
||
| const commentBody = `❌ **PR template is not properly filled:**\n\n- Checkbox1 (reasonable content): ${checkbox1 ? "✅" : "❌"}\n- Checkbox2 (read and accepted): ${checkbox2 ? "✅" : "❌"}\n- URL on correct line: ${urlValid ? "✅" : "❌"}\n- Explanation (> The site content is...): ${explanation ? "✅" : "❌"}\n\nPlease update your PR description accordingly.`; |
There was a problem hiding this comment.
I think we might want some more explicit guidance here on exactly the markup that the check is expecting to find when a check has failed? I also wonder if we simply don't need to include the bits that're okay, to reduce the information that a requester needs to read through?
| @@ -49,38 +49,57 @@ jobs: | |||
|
|
|||
| validate-pr-template: | |||
There was a problem hiding this comment.
We might need to set a concurrency restriction on this, so that you don't end up in a race if the user edits the body multiple times in quick succession, with the wrong comment being the one that ends up sent to GitHub?
| return; | ||
| } | ||
|
|
||
| const commentBody = `❌ **PR template is not properly filled:**\n\n- Checkbox1 (reasonable content): ${checkbox1 ? "✅" : "❌"}\n- Checkbox2 (read and accepted): ${checkbox2 ? "✅" : "❌"}\n- URL on correct line: ${urlValid ? "✅" : "❌"}\n- Explanation (> The site content is...): ${explanation ? "✅" : "❌"}\n\nPlease update your PR description accordingly.`; |
There was a problem hiding this comment.
Can we use an actual multi-line template literal here, instead of encoded \n chars? Should make it much easier to work with and understand what the resulting comment body will be?
MattIPv4
changed the title
| @@ -49,38 +49,57 @@ jobs: | |||
|
|
|||
| validate-pr-template: | |||
| if: github.event_name == 'pull_request' | |||
|
|
|||
| runs-on: ubuntu-latest | |||
|
|
|||
There was a problem hiding this comment.
Ah, and you're going to need to add a permissions stanza that is specific to this job with increased permissions, so that the bot can write comments on the PR.
There is reasonable content on the page (see: No Content)
I have read and accepted the Terms and Conditions
The site content can be seen at Automatically comment on PR template CI failure #9789