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

Stars in multiline release note #26

Closed
erictune opened this issue Jul 2, 2016 · 1 comment
Closed

Stars in multiline release note #26

erictune opened this issue Jul 2, 2016 · 1 comment
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject sig/release Categorizes an issue or PR as relevant to SIG Release.

Comments

@erictune
Copy link
Member

erictune commented Jul 2, 2016

kubernetes/kubernetes#28132
has a multiline release note, which renders as this in the CHANGELOG.md:


  • If you use one of the kube-dns replication controller manifest in cluster/saltbase/salt/kube-dns, i.e. cluster/saltbase/salt/kube-dns/{skydns-rc.yaml.base,skydns-rc.yaml.in}, either substitute one of __PILLAR__FEDERATIONS__DOMAIN__MAP__ or {{ pillar['federations_domain_map'] }} with the corresponding federation name to domain name value or remove them if you do not support cluster federation at this time. If you plan to substitute the parameter with its value, here is an example for {{ pillar['federations_domain_map'] } (#28132, @madhusudancs)
    • pillar['federations_domain_map'] = "- --federations=myfederation=federation.test"

    * where myfederation is the name of the federation and federation.test is the domain name registered for the federation.

I want it to render like this:


  • If you use one of the kube-dns replication controller manifest in cluster/saltbase/salt/kube-dns, i.e. cluster/saltbase/salt/kube-dns/{skydns-rc.yaml.base,skydns-rc.yaml.in}, either substitute one of __PILLAR__FEDERATIONS__DOMAIN__MAP__ or {{ pillar['federations_domain_map'] }} with the corresponding federation name to domain name value or remove them if you do not support cluster federation at this time. If you plan to substitute the parameter with its value, here is an example for {{ pillar['federations_domain_map'] } (#28132, @madhusudancs)
    pillar['federations_domain_map'] = "- --federations=myfederation=federation.test"
    where myfederation is the name of the federation and federation.test is the domain name registered for the federation.

I think the carriage returns need to indent but not have leading stars.

@david-mcmahon
Copy link
Contributor

david-mcmahon commented Jul 2, 2016

Yes I wrestled with this trying to normalize a very varied stream of notes entered by folks.
The rule I settled on is that newlines get stars because more often than not that worked out for formatting.

If a continuous line is desired, edit the PR to remove the newline and we'll regenerate.

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 sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
Development

No branches or pull requests

3 participants