computational-cell-analytics / micro-sam

Segment Anything for Microscopy
https://computational-cell-analytics.github.io/micro-sam/
MIT License
361 stars 43 forks source link

Update release process and add release guide to developer documentation #244

Open GenevieveBuckley opened 1 year ago

GenevieveBuckley commented 1 year ago

Related to https://github.com/computational-cell-analytics/micro-sam/issues/242

I think the release process for micro-sam is a bit complicated (possibly because first things need to be merged from the dev branch to main, and then the release is started and the installers built?)

It would be nice to have this documented.

I'm imagining a small section at the bottom of the new docs/contributing.md introduced in https://github.com/computational-cell-analytics/micro-sam/pull/243 which would have a sentence or two and a link to a separate docs/release-guide.md file.

Here are some other release guides I know of. I don't think we need to use them as a strict model, but if there's anything useful in them we can use, we should do that.

constantinpape commented 1 year ago

I think we need to overhaul the release process. Publishing the napari plugin is a good opportunity for this. And then we should of course also document the process. Let's discuss how to change the release process once we get closer to having a working plugin.

I have updated the title to reflect this.

constantinpape commented 6 months ago

I think it would be best to take care of releases via a dedicated GH action script. A good option is https://github.com/release-drafter/release-drafter, which creates releases when the version is bumped in a PR.

Example workflows for where this is used: https://github.com/bioimage-io/spec-bioimage-io/tree/main/.github/workflows