Skip to content

adding pr description conventions#440

Closed
codergig3 wants to merge 4 commits intolinear-b:mainfrom
codergig3:description
Closed

adding pr description conventions#440
codergig3 wants to merge 4 commits intolinear-b:mainfrom
codergig3:description

Conversation

@codergig3
Copy link
Contributor

No description provided.

Copy link

@orca-security-us orca-security-us bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca

@gitstream-cm gitstream-cm bot requested a review from vim-zz January 24, 2024 08:55
@gitstream-cm
Copy link
Contributor

gitstream-cm bot commented Jan 24, 2024

A screenshot of the relevant part of docs after the changes is a life saver 🛟

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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/\-\[\]/) }}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants