feat: add build documentation verification tool and CI workflow#1274
Open
copernicusjones wants to merge 2 commits into
Open
feat: add build documentation verification tool and CI workflow#1274copernicusjones wants to merge 2 commits into
copernicusjones wants to merge 2 commits into
Conversation
Adds verify_build.py - a Python tool that parses Dasharo building-manual markdown pages, extracts build commands, and runs them in a Docker container with the coreboot SDK to verify the documentation produces the same binary as the published release. Supports: - Device registry mapping slugs → repos, targets, ROM patterns - Markdown code block extraction with shell/bash/language-agnostic parsing - Docker-based build execution with coreboot/coreboot-sdk - SHA256 hash computation for binary comparison - CLI interface: --device/--release for single, --all for batch, --dry-run for parsing only Closes Dasharo#1153
Adds .github/workflows/verify-build-docs.yml that: - Runs on PRs that modify building-manual files - Runs weekly on a schedule (Monday 6am UTC) - Discovers all building-manual.md files in the repo - Parses build commands from markdown code blocks - Reports parse results and validates command extraction Closes Dasharo#1153
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds automated build documentation verification to the Dasharo docs repo. This addresses bounty #1153 by creating a tool + CI workflow that verifies the documented build instructions actually produce correct binaries.
What's new
.github/scripts/verify_build.pycoreboot/coreboot-sdk:latest--device/--releasefor single device,--allfor batch,--dry-runfor parsing only.github/workflows/verify-build-docs.ymlworkflow_dispatchHow it works
building-manual.mdfiles in the repoNext steps
Closes dasharo-issues#1153