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.

Sign up for GitHub

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

Jump to bottom

Use templates for changelog (e.g. PR#1008) #1019

Closed
j0n3lson opened this issue Jan 15, 2020 · 7 comments
Closed

Use templates for changelog (e.g. PR#1008) #1019

j0n3lson opened this issue Jan 15, 2020 · 7 comments
Assignees
@j0n3lson
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@j0n3lson
Copy link
Contributor

Opening this here to discuss whether k/release/cmd/krel should use the same approach as in PR#1008 (e.g. use go-templates).

Both tools do similar things with respect to notes generation/markdown. It would present a common interface for users of either tool

@saschagrunert What do you think?
@j0n3lson
Copy link
Contributor Author

Assuming #1016 move forward, k/release/cmd/krel changelog can take advantage of the new Renderer machinery.

@j0n3lson j0n3lson mentioned this issue Jan 15, 2020
Closed
@saschagrunert
Copy link
Member

Yes I think this makes sense. 👍

@j0n3lson j0n3lson mentioned this issue Mar 4, 2020
Merged
@j0n3lson
Copy link
Contributor Author

j0n3lson commented Mar 4, 2020

@saschagrunert Can you assign this to me please?

@saschagrunert
Copy link
Member

saschagrunert commented Mar 5, 2020 •
edited
Loading

I think so:
/assign @j0n3lson

@saschagrunert saschagrunert mentioned this issue Mar 5, 2020
Merged
@j0n3lson j0n3lson mentioned this issue Mar 7, 2020
Closed
puerco pushed a commit to puerco/release that referenced this issue Mar 17, 2020
@j0n3lson @puerco
This is a follow up to the mentioned PR#1008.
e0cb8b2 
Fixes:

* Fixes new line at the end of rendered templates.

Refactoring:

* Moves validation and reading of template spec from Options into Document and
  colocate the reading of the template file with the template parsing.
  validating the template spec (i.e. "go-template:*") at rendering time is a bit
  easier than trying to parse/validate a spec that also contains go template actions.

* Soft-deprecated FormatSpecMarkdown and Document.RenderMarkdown. The soft
  deprecation adds a deprecation notice but exludes them from golint until so
  linting passes (this will be removed in issue kubernetes#1019).

Testing:

* Enhance golden file testing to simulate reading a user template.
* Enhance golden file testing to cover rendering without downloads.
* Enhance testing to provide line-level diffing between between expected and golden files.
@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 Jun 3, 2020
@saschagrunert
Copy link
Member

/close

This seems to be resolved already.

@k8s-ci-robot
Copy link
Contributor

@saschagrunert: Closing this issue.

In response to this:

/close

This seems to be resolved already.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@j0n3lson j0n3lson

Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@j0n3lson @saschagrunert @k8s-ci-robot @fejta-bot