Preserve markdown order when generating release notes #875
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The markdown notes are now generated in historical order with the newest entries on the top of the document. Signed-off-by: Sascha Grunert <sgrunert@suse.com>
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
size/M
4 tasks
jeefy
reviewed
Sep 28, 2019
| @@ -31,7 +31,9 @@ func CreateDocument(notes ReleaseNoteList) (*Document, error) { | |||
| Uncategorized: []string{}, | |||
| } | |||
|
|
|||
| for _, note := range notes { | |||
| for _, pr := range history { | |||
| note := notes[pr] | |||
There was a problem hiding this comment.
I can't think of any case where something in the history wouldn't also be in notes (that would require a previously-merged PR disappearing) but it might be good/safe to trap that edge case in the future.
jeefy
approved these changes
Sep 28, 2019
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jeefy, saschagrunert The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The markdown notes are now generated in historical order with the newest entries on the top of the document.
PS: I took my freedom to rename
ReleaseNoteListtoReleaseNotes, since it is no actual type of list/slice.