search

rabbitmq / rabbitmq-stream-go-client

A client library for RabbitMQ streams
MIT License
170 stars 20 forks source link

Add release.yml #343

Closed hiimjako closed 3 months ago

hiimjako commented 3 months ago

Added the .github/release.yml file to generate automatically release notes when creating a new release. More info here.

How it Works:

When creating a new release, by clicking the Generate release notes button will automatically fetch and categorize all the merged PRs between the latest tag and the new one, based on the labels in the PRs.

If multiple valid labels are present in a PR, it will choose the one with the highest priority, which is determined by the order they appear in the release.yml file.

If a PR contains the label ignore-for-release it will be skipped regardless of the other labels.

To benefit this feature, each PR should have at least one label from the list to be included in the auto-generation process. I can add a CI action to ensure that each PR has at least one and only one label, but I think it might be more annoying than useful. What do you think?

Also, can you give me your opinion about the categories and titles? Thanks

hiimjako commented 3 months ago

Yes, sure. We just need to merge this PR (this file works only if it is on the main branch) and label all the PRs since the last tag. Then, it should work.

Gsantomaggio commented 3 months ago

@hiimjako feel free to do the next release :) !