chore(deps): update module github.com/nao1215/markdown to v1 #30
No reviewers
Labels
No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
maxpeterkaya/changelog!30
Loading…
Reference in a new issue
No description provided.
Delete branch "renovate/github.com-nao1215-markdown-1.x"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
v0.13.0→v1.1.0Release Notes
nao1215/markdown (github.com/nao1215/markdown)
v1.1.0Compare Source
Changed
go 1.26.0, and Go 1.26 and 1.27 are the two releases the Go team still supports. The exported API and the generated bytes are unchanged.v1.0.0Compare Source
From this release the exported API and the generated bytes are stable. Within
v1.x nothing exported is removed, renamed or re-signatured, and every builder
keeps producing byte-for-byte identical output; the only exception is output
that is objectively wrong, which is fixed in a patch release with the reasoning
recorded here. doc/v1-api-audit.md is the inventory of
the exported symbols they cover.
Added: mermaid diagram types
Added: API
EscapeTableCell, andTableSet.EscapeCellsto apply it to a whole table #113WithBlockSpacing, and with it theOptionparameter onNewMarkdown#111Markdown.BlankLine, the clearer name forLF#111Erroron the entity relationship, flowchart and pie chart builders, which every other builder already had #176Fixed: output that did not render
Each of these replaced output that mermaid refused to draw or that GitHub read
as something other than what the call described. Labels that already rendered
are untouched, which the golden files enforce.
Extending the probe set past the first measurement found more, fixed the same
way #187:
that accepts one; it is written as
<br/>, or as#​10;where that is theform the drawing decodes
~,@or^lost a quadrant chart; a+or@lost a sequencediagram from its participant name; a
^in kanban metadata lost the board<in a title was eaten by the renderer's sanitizer along with the rest;it is written as
#​60;in the title statements that decode it&:, a#cut a period short, and%%losta whole line — the timeline package was the one type the probe had missed
requirement string was drawn as
&\, the half decoded HTML form; it iswritten as
#​92;, which draws the character&,<or>in a git graph or xy chart string was drawn as theliteral text
&,<or>; a<in a block label or arequirement name was read as an opening tag and ate the rest; a
"in apacket field or an xy chart title was drawn as the literal
"— eachis written as the entity form its drawing decodes
edge-case document declares actually reaches the rendered SVG text; parse
and render alone had let each of the above ship
mermaid/archis the one place a label still cannot carry punctuation:mermaid's
architecture-betagrammar accepts only[A-Za-z0-9_ ]and refusesits own escape form, so there is nothing to encode to. The package documentation
says so #171. A sankey node
name refuses
<, tab and zero-width characters along with non-ASCII text, anda front matter title draws every escape of
<as literal text, so those twolimits are documented the same way.
A mermaid title that is not valid UTF-8 is reinterpreted rather than mangled,
which is documented rather than changed #155.
Documentation
Tests and CI
Upgrading from v0.13.0
Your code needs no change. The exported API gained 112 symbols and lost none;
the only signature that changed is
NewMarkdown, which gained a variadicoptions parameter, so every existing call site still compiles. Only code that
assigned the function itself to a
func(io.Writer) *Markdownvariable isaffected.
Your regenerated documents will differ, and not only where the old output
was broken. Running the v0.13.0 sample generators unchanged against this release
gives these differences:
title: Checkoutbecomestitle: "Checkout"titlestatementtitlestatement into the front matter<<Interface>>The first is the widest: nothing about it was broken, and it changes every file.
It is deliberate. markdownlint's MD047 requires the trailing line ending, and
without it a second document appended to the same writer splices its first line
onto the last line of the first. The rest each replaced output that mermaid
would not draw or that YAML read as something other than the title given.
Expect a one-line diff in every generated file, and review the diagram titles
once. After that, v1.x holds the bytes still.
Configuration
📅 Schedule: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate CLI.
⚠️ Artifact update problem
Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.
♻ Renovate will retry this branch, including artifacts, only when one of the following happens:
The artifact failure details are included below:
File name: go.sum
01f9c6513b4d6a0b1f344d6a0b1f349466a13a149466a13a1471c1e32d74View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.Merge
Merge the changes and update on Forgejo.Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.