You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Publishing releases (bumping up versions) and release notes are super important for any OSS project and we can do that automatically based on the Pull requests that are merged.
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 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
Screenshots
This is what draft changes look like 👇🏻
This is how published changes look like 👇🏻
Checklist
I have checked the existing issues
The text was updated successfully, but these errors were encountered:
Description
DX (Developer Experience)
Publishing releases (bumping up versions) and release notes are super important for any OSS project and we can do that automatically based on the Pull requests that are merged.
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 ?
.github/workflows/release-drafter.yml
which will be responsible for drafting your releases based on the branches..github/release-drafter.yml
which will contain a template file and it will decide how the versioning is based upon labelsbug
,feature
, and so on.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 publish a release every week when we merge ourbeta
branch to themain
branch.It is fully based on the labels I add to the PR. If I add a
bug
it will be considered apatch
, forfeature
it goes under theminor
changes, and so on. Learn more about Semantic versioning hereScreenshots
This is what draft changes look like 👇🏻
This is how published changes look like 👇🏻
Checklist
The text was updated successfully, but these errors were encountered: