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

Add Automatic Drafting of Release Notes #3462

Merged
merged 3 commits into from
Apr 11, 2021
Merged

Add Automatic Drafting of Release Notes #3462

merged 3 commits into from
Apr 11, 2021

Conversation

RehanSaeed
Copy link
Contributor

@RehanSaeed RehanSaeed commented Apr 9, 2021

The releases created by this repo have no information in them about what PR was completed. This PR adds release-drafter which automatically drafts release notes but does require you to use the following GitHub labels on your PR's:

Apply one or more of the following to determine the heading the PR will come under:

  • 📚 documentation
  • 🌶️ banana cake pop
  • 🌶️ green donut
  • 🌶️ hot chocolate
  • 🌶️ marshmallow pie
  • 🌶️ strawberry shake
  • 🌶️ website
  • 🧰 maintenance

🧰 maintenance is a new label that will need to be created. I find this label useful for miscellaneous PR's that don't fit under any other category.

You can also apply the following labels (which would need to be created) which automatically increments the major, minor or patch version number in the draft release. I'm not sure you need this part since I'm not sure how you do versioning.

  • major
  • minor
  • patch

For a full walkthrough of how all this works, you can check out my blog post:

https://rehansaeed.com/the-fastest-nuget-package-ever-published-probably/

BTW, the release-drafter build will fail in this PR because there is no release-drafter.yml file checked into the main branch yet.

@michaelstaib
Copy link
Member

Why is the release drafter breaking?

@RehanSaeed
Copy link
Contributor Author

The release-drafter build will fail in this PR because there is no release-drafter.yml file checked into the main branch yet.

@RehanSaeed
Copy link
Contributor Author

Is the versioning story OK?

@michaelstaib
Copy link
Member

cc @PascalSenn

@PascalSenn
Copy link
Member

Looks good to me :) Thanks for putting this together!

@michaelstaib michaelstaib merged commit f294dd3 into ChilliCream:main Apr 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants