search

conventional-changelog / releaser-tools

Create a GitHub/GitLab/etc. release using a project's commit messages and metadata.
MIT License
392 stars 34 forks source link

github: enable generate release notes #214

Closed Kikobeats closed 2 years ago

Kikobeats commented 3 years ago

This is a new GitHub feature. You can read more about that

https://github.blog/2021-10-04-beta-github-releases-improving-release-experience/

Also related:

https://github.com/MylesBorins/node-osc/blob/main/.github/workflows/create-release.yml#L39

Kikobeats commented 2 years ago

@hutson Can you please take a look? 🙂

hutson commented 2 years ago

@Kikobeats I don't actively maintain this repository any longer.

However, my thoughts on this change: Based on the GitHub blog article, and API documentation (https://docs.github.com/en/rest/reference/releases), it sounds like this option would cause GitHub to append the autogenerated content to the end of the release notes generated by conventional-changelog.

If body is specified, the body will be pre-pended to the automatically generated notes.

That could lead to duplication (conventional-changelog automatically generates release notes based on commit messages). If auto generation is also enabled you would end up with a list of commit messages, and a list of PRs, many of them duplicating the same commit message title.

Do you have an example of what this tool does when autogenerated release notes are enabled?

Kikobeats commented 2 years ago

closing then; thanks for reviewing!

Kikobeats commented 2 years ago

@hutson BTW, can I help maintain the project happy to collaborate if you give me the right permissions 🙂

hutson commented 2 years ago

@Kikobeats thank you for the offer. I need to defer to @conventional-changelog/committee for their guidance on your offer since I won't be around to help act as a resource.