Option to include the PR description in a changelog entry?

[NullVoxPopuli]

For libraries, it may be beneficial to include code snippets or migration paths, tips, examples, etc in the changelog.

With changesets, this was the main draw -- with release-it, release-plan / everything else, you have to manage that level of detail separately -- but I think it'd be good to have some sort of opt-in... maybe via label (changelog-use-description) or something to include this level of details.

otherwise, you have to remember all that context during changelog creation time as you edit the preview PR before merge.

thoughts?

[mansona]

Personally I think having a title is enough here. The fact that we keep a link to the PR so people can go and look at the description is more than enough 👍

[NullVoxPopuli]

while that may be true, and a good default, I can see maintainers wanting more thorough changelogs. one demographic that would be interested in this use case are the folks currently using changesets.

Their changelogs tend to look like this:

• https://github.com/statelyai/xstate/releases
• https://github.com/NullVoxPopuli/ember-resources/releases/tag/ember-resources%406.3.1
• https://github.com/NullVoxPopuli/ember-resources/releases/tag/ember-resources%406.3.0
• Long explanation with examples: https://github.com/NullVoxPopuli/ember-resources/releases/tag/ember-resources%406.2.0
• With details for migration steps: https://github.com/NullVoxPopuli/ember-resources/releases/tag/ember-resources%406.0.0