meilisearch / integration-guides

Central reference for Meilisearch integrations.
https://meilisearch.com
MIT License
137 stars 14 forks source link

Change order of changes in release template #148

Closed bidoubiwa closed 1 year ago

bidoubiwa commented 3 years ago

For the moment the release template generates the changes in the following order:

For example it would generate the following (I know some PR's should not be there haha):

## Changes

* Fix typo (#436) @LorenzoSapora
* Extend checkArguments to cover all arguments (#446) @ColinFrick
* Remove !important from scss (#452) @ColinFrick
* Automatic dark/light mode toggle, force dark mode (#453) @ColinFrick
* [Security] Bump ansi-regex from 5.0.0 to 5.0.1 (#454) 

## Breaking changes ⚠️

* Migrate to dart-sass, update divisions (#447) @ColinFrick

The problem is that if the body is too long, the content is cropped. Because breaking changes are after changes it is those changes that are cropped.

Example:

Screenshot 2021-10-21 at 18 04 50

Which is unfortunate as users have to click on read more to see the changes.

I think the breaking changes should always be showcased and thus we should add them before changes

curquiza commented 3 years ago

What you want is to put the breaking changes section at top of the release note? I'm not sure this is possible with the release-drafter unfortunately

alallema commented 3 years ago

I agree it would be more visible. That said, the change of version number tells by itself if there is breaking or not

curquiza commented 3 years ago

Should be fixed by #152: the "breaking change" section will be now at the top of the release draft since there is no more "Change" default section

brunoocasali commented 1 year ago

It seems to be fixed 🎉 Thanks Clem!