search

OpenFreeEnergy / gufe

grand unified free energy by OpenFE
https://gufe.readthedocs.io
MIT License
32 stars 9 forks source link

Backfill news entries for 1.1 gufe release. #382

Open IAlibay opened 6 days ago

IAlibay commented 6 days ago

Add in relevant news entries for rever to generate a changelog.

dotsdl commented 1 day ago

@IAlibay it's not clear to me what you mean. Where do these go? I don't see anything where I would expect to see previous news items: https://github.com/OpenFreeEnergy/gufe/tree/main/news

IAlibay commented 1 day ago

@IAlibay it's not clear to me what you mean. Where do these go? I don't see anything where I would expect to see previous news items: https://github.com/OpenFreeEnergy/gufe/tree/main/news

@dotsdl we started rever for this release, so you won't have anything for now.

rever is a bit different as a system - @mikemhenry might be able to give a small overview of how it works. Effectively you fill in a rst file for each PR and then you use rever to merge them together and create a changelog in /docs.

dotsdl commented 1 day ago

Okay cool, I'll give this a stab with a PR. This can be our PR for our checklist PR template as well.

mikemhenry commented 1 day ago

@dotsdl That is a good idea, we can make a PR template for reviews that includes a checklist for the release process.

But the tl;dr for rever is for each PR that warrants a news entry, you copy the template rst file and fill it out. Then when we cut a release we use rever to merge all the change log entries into a single file. The advantage of doing it this way is it prevents merge conflicts on a central changelog, allows the changelog entry to be reviewed as part of the PR, and also automates copying and pasting the changelog entry like we do in openmmtools. It also doesn't really restrict us in anyway since after the news files is created, we can modify it however we want.