Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release note generation mangles markdown links #299

Closed
calebamiles opened this issue Mar 29, 2017 · 6 comments · Fixed by #445
Closed

release note generation mangles markdown links #299

calebamiles opened this issue Mar 29, 2017 · 6 comments · Fixed by #445
Assignees
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject priority/P1 sig/release Categorizes an issue or PR as relevant to SIG Release.

Comments

@calebamiles
Copy link
Contributor

Comparing the final version of the release notes with the draft [2] it was noted that markdown links will be rendered incorrectly due to what looks like an automated link to PR. The link generation is also subtly incorrect as some links of the form github.com/someCompany/someRepo/issues/someIssue will be rewritten as github.com/kubernetes/kubernetes/pull/someIssue.

cc: @bgrant0607

@xiangpengzhao
Copy link
Contributor

xref: #360

@bgrant0607
Copy link
Member

cc @kubernetes/sig-release-bugs

@xiangpengzhao
Copy link
Contributor

I will try to understand the scripts. @david-mcmahon any ideas?
BTW, we had this issue both in 1.7 (kubernetes/kubernetes#48328) and 1.8 (kubernetes/kubernetes#53286). Hope we don't meet this in the future releases...

@enisoc
Copy link
Member

enisoc commented Oct 18, 2017

For 1.9, I'm hoping to switch to the new Go implementation (#434).

@jennybuckley @roycaihw Does the new implementation still exhibit this problem?

@david-mcmahon
Copy link
Contributor

Good point @enisoc. Once this gets submitted and we integrate with anago, we can close this issue.

@roycaihw
Copy link
Member

@enisoc @david-mcmahon Yes, I think it still exhibit the problem. HTML-izing markdown file is kind of complicated, and the Go implementation relies on the same sed command as #360 pointed out.

@justaugustus justaugustus added sig/release Categorizes an issue or PR as relevant to SIG Release. area/release-eng Issues or PRs related to the Release Engineering subproject labels Dec 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject priority/P1 sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
8 participants