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

chore: Improve change log generator #10841

Merged
merged 3 commits into from
Jun 9, 2024

Conversation

andygrove
Copy link
Member

@andygrove andygrove commented Jun 9, 2024

Which issue does this PR close?

N/A

Rationale for this change

  • Improve the quality of generated changelogs
  • Reduce manual effort required when generating changelogs

What changes are included in this PR?

  • Improved generate-changelog.py script:
    • Includes summary of # of commits and contributors, and credits at the end
    • Add new category other for all PRs that are not in a specific category
    • Removed the list of all PRs merged since it mostly duplicated the categorized entries
    • Generates ASF header so no need to add that manually now
  • I regenerated the 39.0.0 changelog as an example (rendered version)
  • Updated documentation

Are these changes tested?

Are there any user-facing changes?

No

@andygrove andygrove added documentation Improvements or additions to documentation development-process Related to development process of DataFusion labels Jun 9, 2024
@github-actions github-actions bot removed documentation Improvements or additions to documentation development-process Related to development process of DataFusion labels Jun 9, 2024
@andygrove andygrove requested a review from alamb June 9, 2024 13:26
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

Looks like a very nice improvement to me -- thank you @andygrove

## [39.0.0](https://github.com/apache/datafusion/tree/39.0.0) (2024-06-07)
# Apache DataFusion 39.0.0 Changelog

This release consists of 234 commits from 59 contributors. See credits at the end of this changelog for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

this is a great idea. Thank you @andygrove

@alamb
Copy link
Contributor

alamb commented Jun 9, 2024

Let's merge this and iterate on the main branch. Thanks again @andygrove

@alamb alamb merged commit ad0dc2f into apache:main Jun 9, 2024
23 checks passed
@alamb alamb added the development-process Related to development process of DataFusion label Jun 9, 2024
@andygrove andygrove deleted the improve-changelog-generator branch June 9, 2024 20:06
findepi pushed a commit to findepi/datafusion that referenced this pull request Jul 16, 2024
* Improve change log generator

* prettier

* prettier
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development-process Related to development process of DataFusion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants