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.

Sign up for GitHub

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

Jump to bottom

Replace release drafter in favor of GitHub release template #814

Closed
tsalo opened this issue Oct 6, 2021 · 5 comments
Closed

Replace release drafter in favor of GitHub release template #814

tsalo opened this issue Oct 6, 2021 · 5 comments
Labels
good first issue issues that we think are good for new contributors. Equivalent to "very low" effort. impact: low Improving code/documentation cleanliness/clarity, not function maintenance issues related to versioning, dependencies, and other related elements priority: low issues that are not urgent

Comments

@tsalo
Copy link
Member

tsalo commented Oct 6, 2021

Summary

@jbteves has been adding really helpful section headings for us to fill out in our release templates, dividing changes into different types. At the moment, we have to add those sections manually when we go to make the real release. It would be great to just have those empty sections in the template instead.

Next Steps

  1. Discuss any additional sections (or changes to the existing ones) we might want in the template.
  2. Add the sections below to our release-drafter.yml config file.

The template

Release Notes

🔧 Breaking changes

✨ Enhancements

🐛 Bug fixes

Changes since last stable release
@tsalo tsalo added good first issue issues that we think are good for new contributors. Equivalent to "very low" effort. priority: low issues that are not urgent impact: low Improving code/documentation cleanliness/clarity, not function maintenance issues related to versioning, dependencies, and other related elements labels Oct 6, 2021
@tsalo
Copy link
Member Author

tsalo commented Oct 6, 2021 •
edited
Loading

There's also apparently a new "Auto-generate release notes" button in the release drafting page that we could use...

EDIT: With the ability to use a template! See https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#creating-a-template-for-automatically-generated-release-notes

We might just want to drop release drafter altogether...

@tsalo tsalo mentioned this issue Oct 6, 2021
Closed
@jbteves
Copy link
Collaborator

jbteves commented Oct 6, 2021

I will be honest, I'm pretty sure that I'm not the one who started the template, but I can't remember who it was. That said, this would be a great replacement for release-drafter if others agree.

@tsalo
Copy link
Member Author

tsalo commented Oct 6, 2021

Apologies to whoever did start using that template. I was just going off of the release before last.

@tsalo tsalo changed the title Add change type sections to release drafter template Replace release drafter in favor of GitHub release template Oct 6, 2021
@tsalo
Copy link
Member Author

tsalo commented Oct 22, 2021

BTW we can use PR labels to automatically organize the PR into different sections of the release notes. It seems like a halfway point between auto (#571) and what we do now. It would mean adding labels to PRs, but I think it might be worth doing, if everyone's on board.

@tsalo
Copy link
Member Author

tsalo commented Feb 21, 2024

Should have been closed by #1024.

@tsalo tsalo closed this as completed Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue issues that we think are good for new contributors. Equivalent to "very low" effort. impact: low Improving code/documentation cleanliness/clarity, not function maintenance issues related to versioning, dependencies, and other related elements priority: low issues that are not urgent
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tsalo @jbteves