Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DX] Adding automated releases and release notes #1

Closed
1 task done
tamalCodes opened this issue Aug 29, 2023 · 0 comments
Closed
1 task done

[DX] Adding automated releases and release notes #1

tamalCodes opened this issue Aug 29, 2023 · 0 comments

Comments

@tamalCodes
Copy link

tamalCodes commented Aug 29, 2023

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 ?

  • 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 👇🏻

image

This is how published changes look like 👇🏻

image

Checklist

  • I have checked the existing issues
jithindevasia added a commit that referenced this issue Dec 27, 2023
Sync from npci/falcon
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants