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

PR Body passes when valid reference is inside HTML comments #59

Closed
mtfoley opened this issue Nov 12, 2021 · 0 comments · Fixed by #60
Closed

PR Body passes when valid reference is inside HTML comments #59

mtfoley opened this issue Nov 12, 2021 · 0 comments · Fixed by #60
Labels
bug Something isn't working

Comments

@mtfoley
Copy link
Owner

mtfoley commented Nov 12, 2021

Describe the bug
I noticed that pr-compliance-action did not flag the PR description in open-sauced/open-sauced#1299
Looking back, my suspicion is because the PR template markdown includes HTML comments that instruct the contributor how to refer to an issue (https://raw.githubusercontent.com/open-sauced/.github/main/.github/PULL_REQUEST_TEMPLATE.md). The action is picking this instruction up as a false positive.

To Reproduce
Steps to reproduce the behavior:
Submit a PR to open-sauced with an invalid PR body while leaving the commented instructions intact.

Workflow File Contents
See those in open-sauced

Expected behavior
Action flags for invalid PR description

Screenshots
N/A

Additional context
N/A
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: strip html comments from PR description mtfoley/pr-compliance-action
1 participant
@mtfoley