Skip to content

fix(build): detect table formatting changes via git diff#261

Merged
WilliamBerryiii merged 4 commits intomainfrom
fix/table-format-workflow-detection
Jan 24, 2026
Merged

fix(build): detect table formatting changes via git diff#261
WilliamBerryiii merged 4 commits intomainfrom
fix/table-format-workflow-detection

Conversation

@WilliamBerryiii
Copy link
Copy Markdown
Member

Description

Fixes the table-format.yml workflow to properly detect when markdown tables need formatting. The previous implementation relied on the exit code of markdown-table-formatter, which always returns 0 regardless of whether it modified files. The fix uses git diff --name-only to detect actual file changes after running the formatter.

Additionally formats all markdown files with misaligned table pipes to comply with repository conventions.

  • fix(build): replace exit code check with git diff --name-only detection in table-format.yml workflow
  • style(docs): align table pipes vertically in 9 documentation files per markdown.instructions.md

Related Issue(s)

Fixes #253

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):

Sample Prompts (for AI Artifact Contributions)

N/A - This PR does not include AI artifact contributions.

Testing

  • Ran npm run format:tables locally to verify formatter execution
  • Verified git diff --name-only correctly lists modified files
  • Ran npm run lint:yaml - workflow syntax validated
  • Ran npm run lint:md - all markdown files pass linting

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

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

The workflow now properly fails when tables need formatting by:

  1. Running npm run format:tables (modifies files in-place)
  2. Checking git diff --name-only for any changes
  3. Setting TABLE_FORMAT_FAILED=true when changes detected
  4. Listing affected files in workflow output

🔧 - Generated by Copilot

- replace exit code check with git diff detection
- formatter exits 0 regardless of changes made
- now properly sets TABLE_FORMAT_FAILED when files modified

Fixes #253

🔧 - Generated by Copilot
- align table pipes vertically per markdown.instructions.md
- affects 9 files with misaligned tables
- no content changes, whitespace only

Relates to #253

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

github-actions bot commented Jan 24, 2026

Dependency Review

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

Scanned Files

None

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 28.83%. Comparing base (4db1a18) to head (9c1d21d).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #261      +/-   ##
==========================================
+ Coverage   28.80%   28.83%   +0.03%     
==========================================
  Files          14       14              
  Lines        2736     2736              
==========================================
+ Hits          788      789       +1     
+ Misses       1948     1947       -1     
Flag Coverage Δ
pester 28.83% <ø> (+0.03%) ⬆️

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

Fixes the table-format.yml workflow so it detects when npm run format:tables actually modifies files, and normalizes Markdown table formatting across the repo to match established table-pipe alignment conventions.

Changes:

  • Update .github/workflows/table-format.yml to detect formatting changes via git diff --name-only after running the table formatter.
  • Reformat Markdown tables (pipe alignment) across documentation and root Markdown files.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
.github/workflows/table-format.yml Switches table-format failure detection from formatter exit code to post-run git diff output.
docs/getting-started/first-workflow.md Aligns table pipes in the Resources table.
docs/contributing/ROADMAP.md Aligns table pipes in metrics and version history tables.
docs/architecture/workflows.md Aligns table pipes across workflow inventory and pipeline tables.
docs/architecture/testing.md Aligns table pipes in testing/coverage-related tables.
docs/architecture/ai-artifacts.md Aligns table pipes in artifact field, patterns, and maturity tables.
docs/architecture/README.md Aligns table pipes in the component summary table.
docs/README.md Aligns table pipes in audience, differentiators, and quick links tables.
README.md Aligns table pipes in the artifact summary table.
GOVERNANCE.md Aligns table pipes in role/responsibility tables.

Copilot AI review requested due to automatic review settings January 24, 2026 01:13
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

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

@WilliamBerryiii WilliamBerryiii merged commit 985eee0 into main Jan 24, 2026
22 checks passed
@WilliamBerryiii WilliamBerryiii deleted the fix/table-format-workflow-detection branch January 24, 2026 21:13
WilliamBerryiii pushed a commit that referenced this pull request Jan 28, 2026
🤖 I have created a release *beep* *boop*
---


##
[2.0.0](hve-core-v1.1.0...hve-core-v2.0.0)
(2026-01-28)


### ⚠ BREAKING CHANGES

* **agents:** add Task Reviewer and expand RPI to 4-phase workflow
([#277](#277))

### ✨ Features

* **agents:** add hve-core-installer agent to extension package
([#297](#297))
([c0e48c6](c0e48c6))
* **agents:** add Task Reviewer and expand RPI to 4-phase workflow
([#277](#277))
([ae76cab](ae76cab))
* **build:** add code coverage reporting to Pester workflow
([#230](#230))
([a34822a](a34822a))
* **docs:** add GOVERNANCE.md for OSSF Silver Badge compliance
([#235](#235))
([b0e752c](b0e752c))
* **docs:** add ROADMAP.md for OSSF Silver badge compliance
([#238](#238))
([4a41c16](4a41c16))
* **mcp:** add MCP server configuration guidance and installer
enhancements ([#225](#225))
([0bce418](0bce418))
* **scripts:** add YAML linting with actionlint
([#234](#234))
([d9301f9](d9301f9))
* **security:** add OpenSSF Scorecard workflow and badge
([#271](#271))
([7c6d788](7c6d788))
* **skills:** add video-to-gif conversion skill with FFmpeg two-pass
optimization ([#247](#247))
([8d65c42](8d65c42))
* **tests:** add Pester tests for LintingHelpers and
Validate-MarkdownFrontmatter
([#197](#197),
[#198](#198))
([#205](#205))
([51ae563](51ae563))


### 🐛 Bug Fixes

* **build:** detect table formatting changes via git diff
([#261](#261))
([985eee0](985eee0))
* **build:** disable MD024 lint rule in CHANGELOG for release-please
([#220](#220))
([971df94](971df94))
* **build:** quote shell variables and group redirects in workflow files
([#299](#299))
([3372509](3372509))
* **build:** resolve scorecard badge and workflow security issues
([#301](#301))
([aeaed13](aeaed13))
* **extension:** remove frontmatter from README and exclude from
markdown linting
([#223](#223))
([4272529](4272529))
* **instructions:** quote applyTo glob pattern for YAML compatibility
([#216](#216))
([085199c](085199c))
* **scripts:** add FooterExcludePaths parameter to frontmatter
validation ([#334](#334))
([64db98d](64db98d))
* **scripts:** add GHSA word and logs/ exclusion to cspell config
([#214](#214))
([5c99b3f](5c99b3f))
* **scripts:** correct type assertions in Invoke-YamlLint.Tests.ps1
([#332](#332))
([af7050d](af7050d))
* **scripts:** eliminate false positives in dependency pinning npm
pattern ([#273](#273))
([ccbdfa3](ccbdfa3))
* **security:** add artifact attestation for signed releases
([#257](#257))
([c52d6e2](c52d6e2))
* standardize markdown footers and complete frontmatter
([#217](#217))
([b4e7556](b4e7556))


### 📚 Documentation

* add OpenSSF Best Practices Passing badge to README
([#239](#239))
([91bc529](91bc529))
* **architecture:** add architecture documentation and value proposition
([#252](#252))
([0e4b02f](0e4b02f))
* **contributing:** add testing requirements for OSSF compliance
([#254](#254))
([4db1a18](4db1a18))
* **docs:** add enterprise status badges to README header
([#270](#270))
([ccb68a4](ccb68a4))
* **security:** add security assurance case and threat model for OSSF
Silver ([#259](#259))
([a390e26](a390e26))


### ♻️ Refactoring

* **application:** wrap execution with try blocks, ensure proper …
([#296](#296))
([35c4417](35c4417))
* **scripts:** extract frontmatter validation to testable module
([#293](#293))
([4e8707e](4e8707e))
* **scripts:** extract pure functions for Pester testability
([#221](#221))
([d40e742](d40e742))


### 🔧 Maintenance

* **deps-dev:** bump cspell from 9.4.0 to 9.6.0 in the npm-dependencies
group ([#208](#208))
([855914b](855914b))
* **deps-dev:** bump cspell from 9.6.0 to 9.6.1 in the npm-dependencies
group ([#294](#294))
([1e45ad6](1e45ad6))
* **deps:** bump actions/setup-node from 6.1.0 to 6.2.0 in the
github-actions group
([#209](#209))
([c4c69e2](c4c69e2))
* **deps:** bump the github-actions group with 4 updates
([#295](#295))
([d8337b8](d8337b8))
* remove step-security/harden-runner from workflows
([#246](#246))
([c5708d8](c5708d8))

---
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.

[Bug]: Table format check does not detect formatting changes

4 participants