adding pr description conventions #440
Open
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
![orca-security-us[bot]](https://avatars.githubusercontent.com/in/276250?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
…ion_requirements.cm
|
A screenshot of the relevant part of docs after the changes is a life saver 🛟 |
vim-zz
reviewed
Jan 25, 2024
Comment on lines
+7
to
+18
| pr_description_checklist: | ||
| if: | ||
| - {{ pr.description | includes(regex=r/\-\[\]/) }} | ||
| run: | ||
| - action: add-label@v1 | ||
| args: | ||
| label: "Missing Checklist Items" | ||
| color: {{ colors.yellow }} | ||
| - action: request-changes@v1 | ||
| args: | ||
| comment: | | ||
| Please complete the PR checklist before requesting a code review. |
There was a problem hiding this comment.
How about doing 2 checks, one for optional checklist items and one for mandatory. We cna suggest that a check list item that marked as mandatory blocks PR with request change and that optionl one result in a missing label.
- optional
- mandatory *
for the baove mandatory regex is r/\- \[ \].*\*$/
| automations: | ||
| pr_description_checklist: | ||
| if: | ||
| - {{ pr.description | includes(regex=r/\-\[\]/) }} |
There was a problem hiding this comment.
the original regex doesnt cover GitHub markdown checkbox - [ ] which has spaces
Suggested change
| - {{ pr.description | includes(regex=r/\-\[\]/) }} | |
| - {{ pr.description | includes(regex=r/\- \[ \]/) }} |
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.
No description provided.