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

Changelog not formatted correctly #47805

Closed
janetkuo opened this issue Jun 20, 2017 · 8 comments
Closed

Changelog not formatted correctly #47805

janetkuo opened this issue Jun 20, 2017 · 8 comments
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. milestone/removed sig/release Categorizes an issue or PR as relevant to SIG Release.

Comments

@janetkuo
Copy link
Member

The v1.7.0-alpha.4 changelog generated from #39164 PR description has weird format:

image

cc @danwinship

@janetkuo janetkuo added kind/bug Categorizes issue or PR as related to a bug. sig/release Categorizes an issue or PR as relevant to SIG Release. labels Jun 20, 2017
@janetkuo janetkuo added this to the v1.7 milestone Jun 20, 2017
@caesarxuchao
Copy link
Member

cc @david-mcmahon

@danwinship
Copy link
Contributor

danwinship commented Jun 20, 2017

Hm... I wonder if it's because the second line starts with a backtick? It would be easy to reword/rewrap to change that.

The "1. ..." "2. ..." section is also indented too much... I had written it to look right as plain text since that's how it got displayed in the release note field in the PR, but I guess it's supposed to be markdown?

@david-mcmahon
Copy link
Contributor

david-mcmahon commented Jun 20, 2017

Yeah, there's a bunch of translations happening here (pandoc) to get HTML formatted email notifications and md for the changelog from the same human curated md source extracted out of the PR descriptions.

Release notes really should be much simpler than this. There's no need to add an "Action Required" headline as that happens automatically with the release-note-action-required label and there's a lot of formatting going on in this release note (multiple paragraphs, indenting, numbering). KISS is best for release notes.

At this point, the release notes can be hand-modified within changelog as needed to correct any formatting issues.

@dchen1107 dchen1107 modified the milestones: v1.8, v1.7 Jun 23, 2017
@dchen1107
Copy link
Member

We need to fix this, but I don't think this is the release blocker.

@k8s-github-robot
Copy link

[MILESTONENOTIFIER] Milestone Removed

@caesarxuchao @janetkuo

Important:
This issue was missing labels required for the v1.8 milestone for more than 7 days:

priority: Must specify exactly one of [priority/critical-urgent, priority/important-longterm, priority/important-soon].

Removing it from the milestone.

Additional instructions available here The commands available for adding these labels are documented here

@k8s-github-robot k8s-github-robot removed this from the v1.8 milestone Sep 9, 2017
@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.

Prevent issues from auto-closing with an /lifecycle frozen comment.

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 Jan 5, 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 Feb 9, 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. milestone/removed sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
Development

No branches or pull requests

9 participants