Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

✨ Add check for comments in PR description #10

Closed
wants to merge 1 commit into from
Closed

✨ Add check for comments in PR description #10

wants to merge 1 commit into from

Conversation

paranoidsp
Copy link

This adds a check for comments in the PR description.

Fixes #5.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 6, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @paranoidsp!

It looks like this is your first PR to kubernetes-sigs/kubebuilder-release-tools 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder-release-tools has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot requested review from Adirio and mengqiy October 6, 2020 14:45
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: paranoidsp
To complete the pull request process, please assign directxman12 after the PR has been reviewed.
You can assign the PR to them by writing /assign @directxman12 in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 6, 2020
@paranoidsp
Copy link
Author

There do not currently seem to be any tests for the PRPlugins in the verify runner, please let me know if you'd like me to add some based on the tests in the notes package.

@paranoidsp
Copy link
Author

/assign @DirectXMan12

Please review whenever you get a chance.

DirectXMan12
DirectXMan12 requested changes Oct 28, 2020
View reviewed changes
verify/cmd/runner.go
@@ -87,6 +87,10 @@ func main() {
errs = append(errs, "**Your PR has an issue number in the title.**\n\nThe title should just be descriptive.\nIssue numbers belong in the PR body as either `Fixes #XYZ` (if it closes the issue or PR), or something like `Related to #XYZ` (if it's just related).")
}

if regexp.MustCompile(`(?s)<!--.*?-->`).MatchString(pr.GetBody()) {
Copy link
Contributor

Choose a reason for hiding this comment

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

this'll get comments inside code blocks, and other stuff too. At the very least we need to check https://github.com/russross/blackfriday/blob/v2.0.1/html.go#L68.

The "more correct" solution is probably to parse the markdown with blackfriday & look for html nodes that are comment nodes, I think.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 for the "more correct" solution

@DirectXMan12
Copy link
Contributor

(sorry for the delay in review)

@Adirio
Copy link
Contributor

Adirio commented Nov 18, 2020

Should this be implemented as a new PRPlugin? This way we would achieve higher concurrency and more helpful error messages.

Adirio
Adirio suggested changes Nov 18, 2020
View reviewed changes
verify/cmd/runner.go
@@ -87,6 +87,10 @@ func main() {
errs = append(errs, "**Your PR has an issue number in the title.**\n\nThe title should just be descriptive.\nIssue numbers belong in the PR body as either `Fixes #XYZ` (if it closes the issue or PR), or something like `Related to #XYZ` (if it's just related).")
}

if regexp.MustCompile(`(?s)<!--.*?-->`).MatchString(pr.GetBody()) {
Copy link
Contributor

Choose a reason for hiding this comment

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

+1 for the "more correct" solution

@DirectXMan12
Copy link
Contributor

Should this be implemented as a new PRPlugin? This way we would achieve higher concurrency and more helpful error messages.

Yeah, esp if it's gonna be more complex

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 17, 2021
@k8s-ci-robot
Copy link
Contributor

@paranoidsp: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 17, 2021
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 19, 2021
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

@k8s-ci-robot
Copy link
Contributor

@fejta-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Adirio Adirio Adirio requested changes

@DirectXMan12 DirectXMan12 DirectXMan12 requested changes

@mengqiy mengqiy Awaiting requested review from mengqiy

Assignees

@DirectXMan12 DirectXMan12

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

PR description check should ensure that comments are not present
5 participants
@paranoidsp @k8s-ci-robot @DirectXMan12 @Adirio @fejta-bot