ME-ICA / tedana

TE-dependent analysis of multi-echo fMRI
https://tedana.readthedocs.io
GNU Lesser General Public License v2.1
162 stars 95 forks source link

Replace release drafter in favor of GitHub release template #814

Closed tsalo closed 8 months ago

tsalo commented 3 years ago

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 commented 3 years ago

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...

jbteves commented 3 years ago

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 commented 3 years ago

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

tsalo commented 3 years ago

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 commented 8 months ago

Should have been closed by #1024.