Skip to content

Moves Changelogs to Release Notes#546

Merged
danehans merged 2 commits intoenvoyproxy:mainfrom
danehans:release_notes
Oct 17, 2022
Merged

Moves Changelogs to Release Notes#546
danehans merged 2 commits intoenvoyproxy:mainfrom
danehans:release_notes

Conversation

@danehans
Copy link
Copy Markdown
Contributor

@danehans danehans commented Oct 11, 2022 •
edited
Loading

  • Moves changelogs to release-notes since GitHub is auto-generating the changelog per release.
  • Adds generate-artifacts target to add release notes to the release GA workflow.

Signed-off-by: danehans daneyonhansen@gmail.com

@danehans danehans requested a review from a team as a code owner October 11, 2022 22:56
@danehans danehans added the documentation Improvements or additions to documentation label Oct 11, 2022
@danehans danehans added this to the 0.2.0 milestone Oct 11, 2022
@danehans danehans mentioned this pull request Oct 11, 2022
Merged
@arkodg
Copy link
Copy Markdown
Contributor

arkodg commented Oct 11, 2022

might make sense to rename to somewhere/<version>/release-notes to so uploading the file is easier here

gateway/.github/workflows/release.yaml

Line 38 in 5d5c28e

release-artifacts/quickstart.yaml

@danehans
Moves Changelogs to Release Notes
f654733 
Signed-off-by: danehans <daneyonhansen@gmail.com>
@danehans
Adds release-artifacts target with release notes
d030bb8 
Signed-off-by: danehans <daneyonhansen@gmail.com>
@danehans
Copy link
Copy Markdown
Contributor Author

danehans commented Oct 14, 2022

@arkodg commit d030bb8 resolves your feedback above, PTAL.

cc: @Xunzhuo

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Oct 14, 2022

Codecov Report

Merging #546 (d030bb8) into main (319bcb9) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #546   +/-   ##
=======================================
  Coverage   60.93%   60.93%           
=======================================
  Files          46       46           
  Lines        5570     5570           
=======================================
  Hits         3394     3394           
  Misses       1967     1967           
  Partials      209      209

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Xunzhuo
Xunzhuo approved these changes Oct 15, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@Xunzhuo Xunzhuo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@youngnick
Copy link
Copy Markdown
Contributor

youngnick commented Oct 17, 2022

Does this mean that the Github release will have the details from the YAML file on disk? That's probably fine for now, but I think that the Github Release page should have a proper explanation of the changes as far as we can at some point in the future.

@danehans
Copy link
Copy Markdown
Contributor Author

danehans commented Oct 17, 2022

Does this mean that the Github release will have the details from the YAML file on disk?

Yes

That's probably fine for now, but I think that the Github Release page should have a proper explanation of the changes as far as we can at some point in the future.

Maybe we add a step in our release guide that adds the explanations from the release-nodes.yaml into the release markdown page?

@danehans danehans merged commit 3845583 into envoyproxy:main Oct 17, 2022
@danehans danehans deleted the release_notes branch October 17, 2022 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arkodg arkodg arkodg approved these changes

@Xunzhuo Xunzhuo Xunzhuo approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

0.2.0

Development

Successfully merging this pull request may close these issues.

5 participants

@danehans @arkodg @codecov-commenter @youngnick @Xunzhuo