[Feature] Adding automated releases and release notes

tamalCodes commented 1 year ago

Description

I saw that previously we closed #833 which was meant to add this feature up, and we also do have #866 which is also almost the same though having a changelog is somewhat different than having semantic releases scheduled with time.

Here's what I offer. We can use Release Drafter, a popular Opensource action that automatically creates Draft releases for you, along with proper semantic versioning.

How it works ?

We can add up a .github/workflows/release-drafter.yml which will be responsible for drafting your releases based on the branches.
Then if you want "well-formatted" releases you can have .github/release-drafter.yml which will contain a template file and it will decide how the versioning is based upon labels bug, feature and so on.
Also it will help to format the labels with custom titles as per your choice.

Workflow and Demo

If you wish for a demo, head over to Milan's Releases where we draft a release along with proper release notes as soon as we squash-merge a change to the beta branch. We do publish a release every week when we merge our beta branch to the main branch.

It is fully based on the labels I add to the PR. If I add a bug it will be considered a patch, for feature it goes under the minor changes, and so on. Learn more about Semantic versioning here