Collect release note in each PR

[zhaohuabing]

Fix #4472

[zirain]

it would be better to have linter for this.

[zhaohuabing]

it would be better to have linter for this.

Not every PR needs to modify the release note. We can add that later if needed. Checking when reviewing the PR can help solving the current issue.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.96%. Comparing base (04fc944) to head (45eab9b).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4473      +/-   ##
==========================================
- Coverage   65.97%   65.96%   -0.01%     
==========================================
  Files         203      203              
  Lines       31154    31154              
==========================================
- Hits        20554    20551       -3     
- Misses       9415     9418       +3     
  Partials     1185     1185              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[arkodg]

thanks @zhaohuabing the workflow looks great.

I was hoping we can revisit the Release Notes format, right now its focused on changes for a specific area, my preference would be to describe the change in terms of the feature being added or bug being fixed, wdyt @envoyproxy/gateway-maintainers , there's enough past work in this space we can get inspiration from

[zhaohuabing]

@arkodg Good point!

The current format follows Envoy, which makes sense for it as most peoploe working on envoy are developers, and they need to know the technical details of the changes.

However, I believe we should reorganize EG's changelog to better algin with the end users' perspective. As an end user, I would expect to see the following sections in the changelog:

• new features
• security update
• breaking changes
• bug fixes

Minor tasks, such as improvement of CI or fixes for flaky tests, don't need to be included in the changelog.

[arkodg]

hey @zhaohuabing +1 to the proposed format

[arkodg]

also additional sections called performance and other will be useful as well