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

Address markdown format symbols in PR release note block? #29

Closed
xiangpengzhao opened this issue Nov 13, 2017 · 5 comments
Closed

Address markdown format symbols in PR release note block? #29

xiangpengzhao opened this issue Nov 13, 2017 · 5 comments
Labels
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. sig/release Categorizes an issue or PR as relevant to SIG Release.

Comments

@xiangpengzhao
Copy link
Contributor

Some PRs' release notes have markdown format symbols (e.g., -, *), this leads to bad format in the CHANGELOG (see 1.9 changelog).

kubernetes/kubernetes#54175
kubernetes/kubernetes#52792
kubernetes/kubernetes#53043

We may not avoid PR authors to use such symbols, so should we address this case in the release note tool? @roycaihw

/cc @enisoc @david-mcmahon @Bradamant3

@roycaihw
Copy link
Member

PR authors use symbols like - and * for multi-line release notes (kubernetes/kubernetes#54443). It's not clear how are we going to deal with them in current CHANGELOG.
And some release note with unintended newlines (\r\n) can also leads to bad formatting (kubernetes/kubernetes#54177)

These might become worse after we introduce the hierarchical release note(kubernetes/release#435) which uses indention to format the release note.

One possible solution is to squash release note into one line, by removing \r\n and leading -/* in each line.

@xiangpengzhao
Copy link
Contributor Author

It'd be better to take care of this case. Otherwise we should send PR to fix the format in CHANGELOG manually.

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 19, 2018
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten
/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 21, 2018
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

@justaugustus justaugustus added the sig/release Categorizes an issue or PR as relevant to SIG Release. label Dec 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
Development

No branches or pull requests

5 participants