Skip to content

Conversation

Parkreiner
Copy link
Member

@Parkreiner Parkreiner commented Aug 26, 2025

No issue to link – this was a problem we discovered while updating the Registry website

Description

This PR adds (very) basic validation for the GitHub Flavored Markdown alerts that we allow contributors to add to their README files. The errors that get generated should be correct, but the error messages themselves aren't as helpful as they could be. I'm going to be handling that in a separate PR, just so we can get this one in sooner.

Changes made

  • Added function for validating the core structure of all GFM alerts
  • Updated existing README files that were failing the new validation requirements

Type of Change

  • New module
  • Bug fix
  • Feature/enhancement
  • Documentation
  • Other

Copy link
Contributor

@DevelopmentCats DevelopmentCats left a comment

Choose a reason for hiding this comment

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

Besides what you mentioned everything LGTM.

@DevelopmentCats DevelopmentCats merged commit e94dfd2 into main Aug 27, 2025
4 checks passed
@DevelopmentCats DevelopmentCats deleted the mes/gfm-alerts-validation branch August 27, 2025 01:52
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.

2 participants