-
Notifications
You must be signed in to change notification settings - Fork 5
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
Tailor output to look better on a GitHub releases page #104
Conversation
Signed-off-by: Alex Goodman <[email protected]>
Signed-off-by: Alex Goodman <[email protected]>
|
Signed-off-by: Alex Goodman <[email protected]>
@@ -71,7 +82,7 @@ func (m Presenter) formatChangeSections(changes change.Changes) string { | |||
result += formatChangeSection(section.Title, summaries) + "\n" | |||
} | |||
} | |||
return result | |||
return strings.TrimRight(result, "\n") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we now need to remove trailing newlines?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now there is a footer and it became noticeable that we have a large amount of whitespace before the footer -- this makes the whitespace between the content and footer smaller
Signed-off-by: Alex Goodman <[email protected]>
This PR tries to clean up the markdown format and go for a more minimal appearance:
Today:
With changes: (and
title
set to empty string)Note this removes the version / vcs url / date from the top lines of the output. What's really happening is that the
title
has been set to""
, however, it would default to{{ .Version }}
if nothing is provided. I wanted to remove the top lines since the github releases page already has this information, for example:...with the top fields removed it reads a lot better. However, there may be users that are depending on the version being somewhere in the top of the document. For that reason the title now allows for templating and defaults to
{{ .Version }}
.Detailed changes:
#
at the top of the document).Version
valueIssue
andPR
@
in front of usernames (which the releases page should incorporate in a "contributors" footer)Fixes #87