Conversation
Detailed checklists like in https://libertem.github.io/LiberTEM/releasing.html#issue-template-release-checklist that can be copied into an issue or PR work great for us. The merge strategy was mixed when looking into the commit history. In LiberTEM we like to "Rebase and merge", btw. If the commit history is too spotty one can `git rebase -i dev` and squash commits as desired before merging. To be reviewed and updated!
|
Huh, always wondered how to avoid those merge commits. Indeed, rebase and merge seems nice -- let's use that going forward! As for the checklist, my $0.02 is that they might intimidate new contributors not well-versed with git.. The automated actions should catch all these issues, and we can always jump in and fix issues should the arise. Thoughts? |
|
Well, I need this checklist as a co-maintainer of this project! :-D We can also have a One can also argue that detailed, helpful instructions help to onboard new contributors since they give assurance to not make a mistake, and also select for diligent, quality-oriented contributors. 😄 |
|
About the automation, I have a slight inkling that it will confuse me a lot in the future and/or break in unexpected ways, so IMO it is essential to really document how things work -- in particular in case things go haywire, important people left or are on holiday, and one urgently has to fix sth! |
...to not confuse normal contributors.
|
Hey @uellue, thanks for this! The hotfix situation was a fair bit more complicated due to our branch protection rules. I updated the document to read,
and provided the (rather complicated) instructions on how to cherrypick / revert / and re-revert if absolutely necessary. Sound good? |
|
Perfect, this is EXACTLY what I'd need in case the currently released version breaks, you are away and I find dev in a state that I'd not be comfortable to release. Thanks a lot! :-) From my side this is ready to go. Maybe Alex or I can make the next release in due time with you supervising, so that we can test and revise the checklist? |
2 participants
Detailed checklists like in https://libertem.github.io/LiberTEM/releasing.html#issue-template-release-checklist that can be copied into an issue or PR work great for us.
The merge strategy was mixed when looking into the commit history. In LiberTEM we like to "Rebase and merge", btw. If the commit history is too spotty one can
git rebase -i devand squash commits as desired before merging.@gvarnavi can you have a look and update as needed? IMO this should be well-documented so that every maintainer can mint releases without creating a mess! TBH, after a few months I need this for my own projects, too.