Skip to content

fix(docs): quote YAML frontmatter values in BRD template#339

Merged
WilliamBerryiii merged 1 commit intomainfrom
fix/331-brd-template-yaml-frontmatter
Jan 28, 2026
Merged

fix(docs): quote YAML frontmatter values in BRD template#339
WilliamBerryiii merged 1 commit intomainfrom
fix/331-brd-template-yaml-frontmatter

Conversation

@WilliamBerryiii
Copy link
Copy Markdown
Member

Description

Fixed a YAML syntax error in docs/templates/brd-template.md that caused npm run lint:frontmatter to fail. The frontmatter values containing - (space-hyphen-space) and template variables {{...}} were interpreted as YAML block sequence indicators, triggering a "Block sequence entries are not allowed" parse error.

  • Quoted title, description, and author frontmatter fields with double quotes to prevent YAML special character interpretation
  • Updated ms.date from 2025-12-05 to 2026-01-28
  • Added standard Copilot footer with markdownlint disable/enable comments

Related Issue(s)

Closes #331

Type of Change

Select all that apply:

Code & Documentation:

  • Bug fix (non-breaking change fixing an issue)
  • New feature (non-breaking change adding functionality)
  • Breaking change (fix or feature causing existing functionality to change)
  • Documentation update

Infrastructure & Configuration:

  • GitHub Actions workflow
  • Linting configuration (markdown, PowerShell, etc.)
  • Security configuration
  • DevContainer configuration
  • Dependency update

AI Artifacts:

  • Reviewed contribution with prompt-builder agent and addressed all feedback
  • Copilot instructions (.github/instructions/*.instructions.md)
  • Copilot prompt (.github/prompts/*.prompt.md)
  • Copilot agent (.github/agents/*.agent.md)

Note for AI Artifact Contributors:

  • Agents: Research, indexing/referencing other project (using standard VS Code GitHub Copilot/MCP tools), planning, and general implementation agents likely already exist. Review .github/agents/ before creating new ones.
  • Model Versions: Only contributions targeting the latest Anthropic and OpenAI models will be accepted. Older model versions (e.g., GPT-3.5, Claude 3) will be rejected.
  • See Agents Not Accepted and Model Version Requirements.

Other:

  • Script/automation (.ps1, .sh, .py)
  • Other (please describe):

Testing

  • Ran npm run lint:frontmatter -- -Files "docs/templates/brd-template.md" → 0 errors, 0 warnings
  • Ran npm run lint:md → 0 errors across 117 files
  • Verified template variables remain intact for BRD generation workflows

Checklist

Required Checks

  • Documentation is updated (if applicable)
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)
  • Tests added for new functionality (if applicable)

AI Artifact Contributions

N/A - Not an AI artifact contribution

Required Automated Checks

The following validation commands must pass before merging:

  • Markdown linting: npm run lint:md
  • Spell checking: npm run spell-check
  • Frontmatter validation: npm run lint:frontmatter
  • Link validation: npm run lint:md-links
  • PowerShell analysis: npm run lint:ps

Security Considerations

  • This PR does not contain any sensitive or NDA information
  • Any new dependencies have been reviewed for security issues
  • Security-related scripts follow the principle of least privilege

Additional Notes

This fix follows the documented quoting pattern from prompts.md which shows double-quoted template variables as the correct style for YAML frontmatter.

📝 - Generated by Copilot

- quote title, description, and author fields containing special characters
- resolve 'Block sequence entries are not allowed' YAML parse error
- update ms.date to 2026-01-28
- add standard Copilot footer

📝 - Generated by Copilot
@WilliamBerryiii WilliamBerryiii requested a review from a team as a code owner January 28, 2026 19:03
Copilot AI review requested due to automatic review settings January 28, 2026 19:03
@github-actions
Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 41.04%. Comparing base (672d36b) to head (09d2315).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #339      +/-   ##
==========================================
- Coverage   41.08%   41.04%   -0.04%     
==========================================
  Files          15       15              
  Lines        2870     2870              
==========================================
- Hits         1179     1178       -1     
- Misses       1691     1692       +1     
Flag Coverage Δ
pester 41.04% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes a YAML syntax error in the BRD template that was causing frontmatter validation to fail. The fix adds proper quoting to template variables containing special characters and brings the template in line with established codebase conventions.

Changes:

  • Added double quotes around YAML frontmatter values containing template variables and hyphens to prevent YAML parser errors
  • Updated the ms.date field from a past date (2025-12-05) to the current date (2026-01-28)
  • Added the standard Copilot attribution footer with markdownlint control comments

@WilliamBerryiii WilliamBerryiii merged commit ca988f2 into main Jan 28, 2026
22 checks passed
WilliamBerryiii pushed a commit that referenced this pull request Jan 28, 2026
🤖 I have created a release *beep* *boop*
---


##
[2.0.1](hve-core-v2.0.0...hve-core-v2.0.1)
(2026-01-28)


### 🐛 Bug Fixes

* **build:** use draft releases for VSIX upload
([#338](#338))
([f1d3ac6](f1d3ac6))
* **docs:** quote YAML frontmatter values in BRD template
([#339](#339))
([ca988f2](ca988f2))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: hve-core-release-please[bot] <254602402+hve-core-release-please[bot]@users.noreply.github.com>
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.

Fix YAML syntax error in BRD template frontmatter

4 participants