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

[Feature] - Summarize Changelog #6335

Merged
merged 2 commits into from
Apr 24, 2024
Merged

Conversation

IgorWounds
Copy link
Contributor

@IgorWounds IgorWounds commented Apr 23, 2024

  1. Why? (1-3 sentences or a bullet point list):

    • Reading a changelog as just a list of PRs can be cumbersome. Having a summary for each section of the main changes helps understanding.
  2. What? (1-3 sentences or a bullet point list):

    • Added a summary that uses the GitHub API to collect PR descriptions that are part of the release. Then, it summarizes them for each section of the changelog.
  3. Impact (1-2 sentences or a bullet point list):

    • Low impact. Bumps the time of generating the changelog and adds a new key to GitHub secrets.
  4. Testing Done:

    • This needs to be merged to test.

@IgorWounds IgorWounds added enhancement Enhancement platform OpenBB Platform labels Apr 23, 2024
Copy link
Contributor

@luqmanbello luqmanbello left a comment

Choose a reason for hiding this comment

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

This looks good.

@IgorWounds IgorWounds marked this pull request as ready for review April 24, 2024 10:49
@IgorWounds IgorWounds added this pull request to the merge queue Apr 24, 2024
Merged via the queue into develop with commit b418288 Apr 24, 2024
12 checks passed
@IgorWounds IgorWounds deleted the feature/changelog-summary branch April 24, 2024 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement platform OpenBB Platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants