search

fatiando / community

Community resources, guidelines, meeting notes, authorship policy, maintenance, etc.
Other
8 stars 4 forks source link

Ease the process of generating the changelog for releases? #147

Open santisoler opened 5 months ago

santisoler commented 5 months ago

Description:

Today I learned that GitHub now offers a button to auto generate the changelog (release notes) when drafting a new Release: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

I think this could ease the process we have right now for generating the changelog when we create a new release.

I would like to see what it actually does and if it misses some bits we currently add to the changelog.

santisoler commented 5 months ago

As an example, it generated this list when drafting a new release for Choclo:

## What's Changed
* Update Black formatting to version 24.2 by @leouieda in https://github.com/fatiando/choclo/pull/61
* Restore kernels for point masses by @santisoler in https://github.com/fatiando/choclo/pull/58
* Update the CodeCov action by @leouieda in https://github.com/fatiando/choclo/pull/62
* Update Leo's affiliation from Liverpool to São Paulo by @leouieda in https://github.com/fatiando/choclo/pull/60
* Update the versions of sphinx and its plugins by @leouieda in https://github.com/fatiando/choclo/pull/64
* Mention SimPEG collaboration in docs by @santisoler in https://github.com/fatiando/choclo/pull/65
* Use pip instead of conda for the docs workflow by @leouieda in https://github.com/fatiando/choclo/pull/63
* Use Burocrata to check/add license notices by @leouieda in https://github.com/fatiando/choclo/pull/66
* Use Dependabot to manage GitHub Actions updates by @leouieda in https://github.com/fatiando/choclo/pull/68
* Setup Trusted Publisher deployment to PyPI by @leouieda in https://github.com/fatiando/choclo/pull/67
* Bump styfle/cancel-workflow-action from 0.5.0 to 0.12.1 by @dependabot in https://github.com/fatiando/choclo/pull/69
* Bump pypa/gh-action-pypi-publish from 1.3.1 to 1.8.14 by @dependabot in https://github.com/fatiando/choclo/pull/70
* Bump actions/download-artifact from 2 to 4 by @dependabot in https://github.com/fatiando/choclo/pull/73
* Bump actions/upload-artifact from 2 to 4 by @dependabot in https://github.com/fatiando/choclo/pull/72
* Bump actions/checkout from 2 to 4 by @dependabot in https://github.com/fatiando/choclo/pull/71
* Bump actions/cache from 2 to 4 by @dependabot in https://github.com/fatiando/choclo/pull/75
* Bump actions/setup-python from 2 to 5 by @dependabot in https://github.com/fatiando/choclo/pull/76
* Drop support for Python 3.7 by @santisoler in https://github.com/fatiando/choclo/pull/78
* Extend support for Python 3.12 by @santisoler in https://github.com/fatiando/choclo/pull/79
* Replace `_version_generated.py` for `_version.py` by @santisoler in https://github.com/fatiando/choclo/pull/80

## New Contributors
* @dependabot made their first contribution in https://github.com/fatiando/choclo/pull/69

**Full Changelog**: https://github.com/fatiando/choclo/compare/v0.1.0...v0.1.1

Apparently it's not grabbing text from the descriptions of the PRs, something we usually try to include in the changelog. It also not splitting the changes into categories, but I think this could be done and configured by using labels in the PRs.