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.

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

ci: Add a Release Notes template and label categorization for easy auto generation. #335

Merged
merged 3 commits into from
Nov 14, 2024

Conversation

AlfredoG87
Copy link
Contributor

Description:
Added .github/release.yaml for Generating better release notes automatically by GH]

Related issue(s):

Fixes #334

Notes for reviewer:
This might be needed to be tested a couple times before it works as expected 😅

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

@AlfredoG87 AlfredoG87 self-assigned this Nov 9, 2024
@AlfredoG87 AlfredoG87 added Release Issues tied to release management functions Improvement Code changes driven by non business requirements labels Nov 9, 2024
@AlfredoG87 AlfredoG87 added this to the 0.3.0 milestone Nov 9, 2024
@AlfredoG87 AlfredoG87 marked this pull request as ready for review November 9, 2024 19:11
@AlfredoG87 AlfredoG87 requested review from a team as code owners November 9, 2024 19:11
…future we can experiment with release_drafter tool.

Signed-off-by: Alfredo Gutierrez <[email protected]>
Signed-off-by: Alfredo Gutierrez <[email protected]>
@AlfredoG87 AlfredoG87 force-pushed the release-notes-template branch from e559294 to 0ee0050 Compare November 12, 2024 22:49
Copy link
Contributor

@rbarkerSL rbarkerSL left a comment

Choose a reason for hiding this comment

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

Approving for now, approved something similar and they added github_actions and internal labels as the internal changelog category. May be something to consider in another ticket.

@AlfredoG87
Copy link
Contributor Author

Approving for now, approved something similar and they added github_actions and internal labels as the internal changelog category. May be something to consider in another ticket.

Yeah, I also think that could be the better way to go actually, do you have that example so I can use it as inspiration for our repo?

@AlfredoG87 AlfredoG87 merged commit 2e4d26b into main Nov 14, 2024
13 checks passed
@AlfredoG87 AlfredoG87 deleted the release-notes-template branch November 14, 2024 02:05
Copy link

codecov bot commented Nov 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.05%. Comparing base (fb81199) to head (0ee0050).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #335   +/-   ##
=========================================
  Coverage     94.05%   94.05%           
  Complexity      300      300           
=========================================
  Files            68       68           
  Lines          1177     1177           
  Branches         82       82           
=========================================
  Hits           1107     1107           
  Misses           57       57           
  Partials         13       13           

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Code changes driven by non business requirements Release Issues tied to release management functions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a Release Notes template to the repo to Easily Generate Release Notes
6 participants