fix: correct release-note rendering (markdown list + dropped first char)#3476
Merged
tekton-robot merged 2 commits intoJul 1, 2026
Merged
Conversation
The generated draft release notes wrote the Docs and Examples links as `-[Docs @ ...]` and `-[Examples @ ...]`, with no space after the dash. Without the space these are not valid markdown list items and render as a single run-on line. Add the missing space so they render as a list.
tekton-robot
added
the
size/XS
The release-note extraction used a fixed-width lookbehind:
grep -oPz '(?s)(?<=```release-note..)(.+?)(?=```)'
The trailing `..` was intended to skip the line break after the
```release-note fence, assuming CRLF (\r\n). When the PR body uses LF
line endings the `..` matches the newline plus the first character of
the note, so descriptions rendered as "rrors ..." instead of
"Errors ...", "ump ..." instead of "Bump ...", etc.
Replace the brittle regex with an awk extraction that captures the
lines strictly between the ```release-note fences after normalising
line endings, so the full description is preserved regardless of CRLF
or LF.
tekton-robot
added
size/S
vdemeester
changed the title
AlanGreene
approved these changes
Jul 1, 2026
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: AlanGreene The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
Contributor
|
/lgtm |
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
4 participants
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.
Changes
Two fixes to the generated draft release notes (
tekton/resources/release/base/github_release.yamlandgithub_release_oci.yaml):1. Docs/Examples not rendered as a list
The Docs and Examples links were written as
-[Docs @ ...]/-[Examples @ ...](no space after the dash), so they were not valid markdown list items and rendered as a run-on line. Added the missing space (- [Docs @ ...]).2. First character of every release-note description dropped
The release-note extraction used a fixed-width lookbehind:
The trailing
..was intended to skip the line break after the fence assuming CRLF (\r\n). When the PR body uses LF line endings,..matches the newline plus the first character of the note, so descriptions rendered as "rrors ..." instead of "Errors ...", "ump ..." instead of "Bump ...", etc.Replaced the brittle regex with an awk extraction that captures the lines strictly between the ```release-note fences after normalising line endings, preserving the full description regardless of CRLF/LF.
Both observed in the tektoncd/pipeline v1.14.0 draft release notes.
/kind bug
Submitter Checklist