Repository navigation
Write each paragraph of the GitHub release text on one line - #91
Merged
Merged
Conversation
A GitHub release draws every line break as a break. changes.md wraps its lines, which a Markdown page reads as one paragraph, so the release pages broke sentences in the middle: 662 times on 0.6.0, and 351, 147 and 88 times on 0.3.0, 0.4.0 and 0.5.0. publish now joins the lines of each paragraph and list item. A blank line and a new list item start a new line. Headings, tables, quotes, HTML, rules, fenced code and hard breaks stay as they are. The test's changelog has each of these, and fails with the old text.
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.
A GitHub release draws every line break as a break.
changes.mdwraps its lines, which a Markdown page reads as one paragraph, so the release pages broke sentences in the middle: 662<br>on 0.6.0, and 351, 147 and 88 on 0.3.0, 0.4.0 and 0.5.0.tools/release/release.sh:release_textpasses the changelog through a newunwrap_lines, which joins the lines of each paragraph and list item with one space, as Markdown reads them. A blank line and a new list item start a new line. Headings, table rows, quotes, HTML lines, rules, fenced code blocks and hard breaks stay as they are.changes.mditself stays wrapped.tools/test/release-publish/publish_test.go: the fixture changelog now has a wrapped paragraph, a wrapped list item with a nested item and a second paragraph, a hard break, a fenced code block and a table, and the fakeghchecks each in the textpublishsends. With the old pipeline the test fails.The four published release pages were written again with this
unwrap_lines, from their own text. On each, the text with all white space collapsed is the same as before, the counts of list items and headings are the same, the rendered page has no<br>left, and the text of the rendered page is the same apart from the breaks. Nothing else of the releases changed: title, assets, prerelease state and the Latest label. The changelog part of the 0.6.0 page is byte for byte what thisrelease_textwrites from the tag.go test ./tools/test/release-publish/...and the docs tests in./testspass.