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.

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

fix: strip html comments from PR description #60

Merged
merged 1 commit into from Nov 12, 2021

Conversation

mtfoley
Copy link
Owner

@mtfoley mtfoley commented Nov 12, 2021

What type of PR is this? (check all applicable)

  • ♻️ Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • 👷 Optimization
  • 📝 Documentation Update
  • 🔖 Release
  • 🚩 Other

Description

This PR updates the checks.ts and associated tests to handle PR descriptions better, by stripping the HTML comments out.

Related Tickets & Documents

This PR fixes #59 .

Mobile & Desktop Screenshots/Recordings

N/A

Added tests?

Added one more test to show case of invalid PR description that has a valid reference inside a commented section.

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentation?

  • 📜 readme
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

Observe, baby

[optional] What gif best describes this PR or how it makes you feel?

doh

@mtfoley mtfoley merged commit 24a4e00 into main Nov 12, 2021
@mtfoley mtfoley deleted the fix-strip-html-comments branch January 4, 2022 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PR Body passes when valid reference is inside HTML comments
1 participant