Fix README formatting to unblock v20260512 build#59
Closed
svc-finitelabs[bot] wants to merge 2 commits into
Closed
Fix README formatting to unblock v20260512 build#59svc-finitelabs[bot] wants to merge 2 commits into
svc-finitelabs[bot] wants to merge 2 commits into
Conversation
The v20260512 release commit regenerated README.md via pandoc but did not run the prettier step. `make build` runs pandoc + prettier and the CI "Check for dirty tree" step failed because prettier reformatted the committed README. Apply `prettier --prose-wrap always` to bring README.md in sync with what the build pipeline produces. Fixes failing build run: https://github.com/finitelabs/control4-esphome/actions/runs/25742811133
Contributor
Author
|
Superseded — Derek force-pushed the prettier fix onto v20260512 directly (commit 472ba8d). main and v20260512 are now identical and the v20260512 release is published. Closing. |
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
1 participant
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
4e33bfa(Release v20260512) regeneratedREADME.mdvia pandoc but did not run the prettier step. The committed README still has the pandoc-raw output (e.g.------…------for horizontal rules, narrower prose wrap, condensed tables).make buildrunsdocs(pandoc) →fmt(prettier), so the build's "Check for dirty tree" step fails: see failed run.prettier --prose-wrap always --write README.md(no manual content edits), bringing the committed file in sync with what the build pipeline produces.Release implications
The
v20260512tag points at the failing commit, so the Release workflow couldn't create the GitHub Release. After this PR merges, you'll likely want to either:v20260512tag to the new merge commit (and re-run release.yml), orv20260513).Deferring to you on which.
Test plan