fix(release): an empty code block in the notes, and a check for the next one - #24
Merged
Conversation
…ext one Reported by the first person to read the v0.1.0 release notes. It came from editing the heredoc that writes them by string substitution: the insertion ended with an opening fence directly above a closing fence that was already there, so the two paired up around nothing. The diff looked fine. Nothing rendered the result, and Markdown has no compiler to complain. So CI has one. check-release-notes.py renders the header the way the workflow does and fails on unbalanced fences or empty blocks — the two mistakes that survive review by looking correct in a diff. The published v0.1.0 notes were edited in place. The release itself worked on its first run, and is verified against what was published rather than what was built: both tarballs' checksums match, and the binaries out of both report 0.1.0 — the aarch64 half under emulation. The versioned image pulls anonymously. Third time in this project that the failure was editing text without looking at the output, and the second time it reached somebody. Named as a pattern in ROADMAP rather than left as three separate slips.
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.
Reported by the first person to read the v0.1.0 notes.
It came from editing the heredoc that writes the notes by string
substitution: my insertion ended with an opening fence directly above a
closing fence that was already there, so the two paired up around
nothing. The diff looked fine.
Markdown has no compiler, so CI is one now
.github/scripts/check-release-notes.pyrenders the header exactly asthe workflow does and fails on unbalanced fences or empty code blocks —
the two mistakes that survive review by looking correct in a diff.
The published v0.1.0 notes were edited in place.
The release itself
Worked on its first run, and is verified against what was published
rather than what was built:
sha256match.oxinit,oxctlandoxlogdout of the x86_64 tarball report0.1.0.ghcr.io/youhide/oxinit:v0.1.0pulls anonymously.A pattern, not three slips
This is the third time in this project the failure was editing text
without looking at the output, and the second time it reached somebody.
Named as such in ROADMAP.