From ec5be692293b26c3e3168bc2f1674dcb4706e562 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Tue, 20 Aug 2024 14:58:09 +0100 Subject: [PATCH 01/16] add bio-formats release instruction --- docs/bioformats-release-process.rst | 195 ++++++++++++++++++++++++++++ 1 file changed, 195 insertions(+) create mode 100644 docs/bioformats-release-process.rst diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst new file mode 100644 index 0000000..021f734 --- /dev/null +++ b/docs/bioformats-release-process.rst @@ -0,0 +1,195 @@ +BioFormats release +================== + +.. _Bio-Formats: https://github.com/ome/bioformats +.. _Bio-Formats Documentation: https://github.com/ome/bio-formats-documentation +.. _Bio-Formats Downloads: https://downloads.openmicroscopy.org/bio-formats/ +.. _Octave Docker: https://github.com/ome/bio-formats-octave-docker +.. _Read The Docs: https://readthedocs.org/projects/bio-formats/builds/ +.. _Data Repository: https://github.com/openmicroscopy/data_repo_config + +This document describes the release process the `Bio-Formats`_ Java library. +The release process uses GitHub actions, make sure that the actions are active before pushing any tag. + +Before starting the release process, +open a Pull Request with a new release entry in the `whats-new `_ page. When approved by both the OME team and the Glencoe Software team, merge and start the release process. + + +Release process +^^^^^^^^^^^^^^^ + +Source code release +------------------- + +Before making a new release, merge all contributions on the ``develop`` branch of `Bio-Formats`_. + +The first operation to perform a Maven release is to bump the version out of +SNAPSHOT using the Maven versions plugin, add and commit:: + + $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false + $ mvn versions:set-property -Dproperty=release.version -DnewVersion=x.y.z -DgenerateBackupPoms=false + $ git add -u . + $ git commit -m “Bump release version to x.y.z” + + +A signed tag must be created for the released version using :command:`git tag -s`:: + + $ git tag -s -m "Tag version x.y.z" vx.y.z + + +Revert to ``SNAPSHOT``, add and commit:: + + $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false + $ git add -u . + $ git commit -m “Revert to snapshot” + +Both the `master` branch as well as the tag must be pushed upstream:: + + $ git push origin master vx.y.z + +This will trigger GitHub action builds, generate artifacts, create a GitHub release and upload +the artifacts to the release on GitHub. +An hourly cron job runs on our virtual machine and copy the artifacts published on Github under `Bio-Formats Downloads`_. + +Close the milestone if any and add new one if needed. + +Documentation release +--------------------- + +Before making a new release, merge all contributions on the ``master`` branch of `Bio-Formats Documentation`_. + +The first operation to perform a Maven release is to bump the version out of +SNAPSHOT using the Maven versions plugin, add and commit:: + + $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false + $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=x.y.z -DgenerateBackupPoms=false + $ mvn versions:set-property -Dproperty=bio-formats-examples.version -DnewVersion=x.y.z -DgenerateBackupPoms=false + $ git add -u . + $ git commit -m “Bump release version to x.y.z” + + +Revert to ``SNAPSHOT``, add and commit:: + + $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false + $ git add -u . + $ git commit -m “Revert to snapshot” + +Both the `master` branch as well as the tag must be pushed upstream:: + + $ git push origin master vx.y.z + + +The documentation is built and published on `Read The Docs`_. + +An hourly cron job runs on our virtual machine and adds redirect from for example `docs.openmicroscopy.org/bio-formats/7.3.1 `_ to `omero.readthedocs.io/en/v7.3.1/ `_. + +Close the milestone if any and add new one if needed. + +Fiji Update site +---------------- + +Before making a release, merge all contributions on the ``master`` branch of `Bio-Formats Fiji `_. + +The first operation to perform a Maven release is to bump the version out of +SNAPSHOT using the Maven versions plugin, add and commit:: + + $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false + $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=.y.z -DgenerateBackupPoms=false + $ git add -u . + $ git commit -m “Bump release version to x.y.z” + $ git push origin master + $ mvn clean package -Dfiji.home=x.y.z + +`Upload `_ the generated jars to the update site. + + +Revert to ``SNAPSHOT``, add, commit and push to origin:: + + $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false + $ git add -u . + $ git commit -m “Revert to snapshot” + $ git push origin master + +Homebrew +-------- + +- Update the `Bio-Formats formula `_ + by pointing to the ``bioformats-RELEASE.zip`` and update the ``sha256`` value. The ``sha256`` can be found in the ``SHASUM`` file under https://downloads.openmicroscopy.org/bio-formats/RELEASE/artifacts/. +- Update the version and sha256 in the ``.rb`` file corresponding to the current release. + + +Add, commit the changes and push to origin:: + + $ git add -u . + $ git commit -m “Bump release version to x.y.z” + $ git push origin master + + +Docker container release +------------------------ + +Before making a new release, merge all contributions on the `master` branch (rare) of `Octave Docker`_. + +When the artifacts are available under `Bio-Formats Downloads`_, you can release the `Octave Docker`_. +Bump the version in `Dockerfile `_ to the latest release version. + +Add, commit the changes and push to origin:: + + $ git add -u . + $ git commit -m “Bump release version to x.y.z” + $ git push origin master + +Close the milestone if any and add new one if needed. + + +Data repository release +----------------------- + +Before making a new release, merge all contributions on the `master` branch of `Data Repository`_. + +A signed tag must be created for the released version using :command:`git tag -s`:: + + $ git tag -s -m "Tag version x.y.z" vx.y.z + $ git push origin master + + + +Website release +--------------- + +When the documentation is deployed, you can make a release of the `Open Microscopy Environment`_ website. + +To make a release: + - Update the version in `_config.yml `_ + - Add a new entry under `_posts `_. The name of the post should be ``YYYY-MM-DD-omero-MAJOR-MINOR-PATCH.md`` e.g. ``2024-08-15-omero-5-6-13.md`` + - Point to the post announcing the release in `omero/downloads/index.html `_. + + +A signed tag must be created using :command:`git tag -s`:: + + $ git tag -s -m "Message" YYYY.MM.DD + +Before pushing, make sure that the documentation has been built and published on `Read The Docs`_. +Both the `master` branch as well as the tag must be pushed upstream:: + + $ git push origin master YYYY.MM.DD + +An hourly cron job runs on our virtual machine and deploys the website. + + +Announcement +------------ + + - Announce the release on `image.sc`_ using the ``Announcements`` category after checking that the website has been deployed. + - Confocal email + - X/linkedin + + +Post Release +------------ + + - Add an entry in `Web Server Stats`_. + - Bump bio-formats version in `omero-model `_. + - Bump bio-formats version in `OMEZarrReader `_. + - Bump bio-formats version in `pom-scijava `_. + From 5be4caa972534504d5b410ec9029927f7c883cac Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Tue, 20 Aug 2024 14:58:29 +0100 Subject: [PATCH 02/16] add bio-formats release page to index --- docs/components-release.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/components-release.rst b/docs/components-release.rst index 4a9a474..8315685 100644 --- a/docs/components-release.rst +++ b/docs/components-release.rst @@ -8,6 +8,7 @@ Note this is not an exhaustive list of all tools release process. .. toctree:: :maxdepth: 1 + bioformats-release-process cpp-development gradle-development java-development From b565096617ea67d48801febf635f5f757d39930d Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Tue, 20 Aug 2024 14:58:46 +0100 Subject: [PATCH 03/16] add link to Web server stats --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index 0cc517f..fb4e42e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -171,6 +171,7 @@ .. _Conda: https://docs.conda.io/en/latest/ .. _PyTables: http://pytables.org .. _image.sc: https://forum.image.sc/ +.. _Web Server Stats: https://docs.google.com/spreadsheets/d/1K7ab1UpuiE3FmAq3et7OpyxFwumrT7z8tGrDDBSDxsk/edit#gid=908994883 .. |SSH| replace:: :abbr:`SSH (Secure Shell)` .. |VM| replace:: :abbr:`VM (Virtual Machine)` From 7911a8a0cca772a2c0ef2a6c4385446f286f543a Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Tue, 20 Aug 2024 16:38:18 +0100 Subject: [PATCH 04/16] point to bio-formats instead of omero --- docs/bioformats-release-process.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 021f734..24d5037 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -81,7 +81,7 @@ Both the `master` branch as well as the tag must be pushed upstream:: The documentation is built and published on `Read The Docs`_. -An hourly cron job runs on our virtual machine and adds redirect from for example `docs.openmicroscopy.org/bio-formats/7.3.1 `_ to `omero.readthedocs.io/en/v7.3.1/ `_. +An hourly cron job runs on our virtual machine and adds redirect from for example `docs.openmicroscopy.org/bio-formats/7.3.1 `_ to `bio-formats.readthedocs.io/en/v7.3.1/ `_. Close the milestone if any and add new one if needed. @@ -162,7 +162,7 @@ When the documentation is deployed, you can make a release of the `Open Microsco To make a release: - Update the version in `_config.yml `_ - Add a new entry under `_posts `_. The name of the post should be ``YYYY-MM-DD-omero-MAJOR-MINOR-PATCH.md`` e.g. ``2024-08-15-omero-5-6-13.md`` - - Point to the post announcing the release in `omero/downloads/index.html `_. + - Point to the post announcing the release in `bio-formats/downloads/index.html `_. A signed tag must be created using :command:`git tag -s`:: From 2d9af7393701cf5a0ceba88bc278ee6e686a991b Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Tue, 20 Aug 2024 16:39:50 +0100 Subject: [PATCH 05/16] indicate that the artifacts are uploaded to OME artifactory --- docs/bioformats-release-process.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 24d5037..2759f65 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -48,7 +48,7 @@ Both the `master` branch as well as the tag must be pushed upstream:: $ git push origin master vx.y.z This will trigger GitHub action builds, generate artifacts, create a GitHub release and upload -the artifacts to the release on GitHub. +the artifacts to the release on GitHub and to the `OME artifactory`_. An hourly cron job runs on our virtual machine and copy the artifacts published on Github under `Bio-Formats Downloads`_. Close the milestone if any and add new one if needed. From e76d407dc23a830030c4d9a5aef7e74a7fb925a2 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 22 Aug 2024 09:24:54 +0100 Subject: [PATCH 06/16] capitalize BF --- docs/bioformats-release-process.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 2759f65..b481cde 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -189,7 +189,7 @@ Post Release ------------ - Add an entry in `Web Server Stats`_. - - Bump bio-formats version in `omero-model `_. - - Bump bio-formats version in `OMEZarrReader `_. - - Bump bio-formats version in `pom-scijava `_. + - Bump Bio-Formats version in `omero-model `_. + - Bump Bio-Formats version in `OMEZarrReader `_. + - Bump Bio-Formats version in `pom-scijava `_. From 12f500d7d77433bd65d873caa7dcc7f5b861fe8c Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 22 Aug 2024 09:25:50 +0100 Subject: [PATCH 07/16] master -> develop --- docs/bioformats-release-process.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index b481cde..06f288f 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -43,9 +43,9 @@ Revert to ``SNAPSHOT``, add and commit:: $ git add -u . $ git commit -m “Revert to snapshot” -Both the `master` branch as well as the tag must be pushed upstream:: +Both the `develop` branch as well as the tag must be pushed upstream:: - $ git push origin master vx.y.z + $ git push origin develop vx.y.z This will trigger GitHub action builds, generate artifacts, create a GitHub release and upload the artifacts to the release on GitHub and to the `OME artifactory`_. From 1f7754cab4e639d17e3d5df9415db44c2d561273 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 22 Aug 2024 09:28:48 +0100 Subject: [PATCH 08/16] fix double quote format --- docs/bioformats-release-process.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 06f288f..c324ab4 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -41,7 +41,7 @@ Revert to ``SNAPSHOT``, add and commit:: $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false $ git add -u . - $ git commit -m “Revert to snapshot” + $ git commit -m "Revert to snapshot" Both the `develop` branch as well as the tag must be pushed upstream:: @@ -65,14 +65,14 @@ SNAPSHOT using the Maven versions plugin, add and commit:: $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=x.y.z -DgenerateBackupPoms=false $ mvn versions:set-property -Dproperty=bio-formats-examples.version -DnewVersion=x.y.z -DgenerateBackupPoms=false $ git add -u . - $ git commit -m “Bump release version to x.y.z” + $ git commit -m "Bump release version to x.y.z" Revert to ``SNAPSHOT``, add and commit:: $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false $ git add -u . - $ git commit -m “Revert to snapshot” + $ git commit -m "Revert to snapshot" Both the `master` branch as well as the tag must be pushed upstream:: @@ -96,7 +96,7 @@ SNAPSHOT using the Maven versions plugin, add and commit:: $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=.y.z -DgenerateBackupPoms=false $ git add -u . - $ git commit -m “Bump release version to x.y.z” + $ git commit -m "Bump release version to x.y.z" $ git push origin master $ mvn clean package -Dfiji.home=x.y.z @@ -107,7 +107,7 @@ Revert to ``SNAPSHOT``, add, commit and push to origin:: $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false $ git add -u . - $ git commit -m “Revert to snapshot” + $ git commit -m "Revert to snapshot" $ git push origin master Homebrew @@ -121,7 +121,7 @@ Homebrew Add, commit the changes and push to origin:: $ git add -u . - $ git commit -m “Bump release version to x.y.z” + $ git commit -m "Bump release version to x.y.z" $ git push origin master @@ -136,7 +136,7 @@ Bump the version in `Dockerfile Date: Thu, 22 Aug 2024 10:22:29 +0100 Subject: [PATCH 09/16] examples release --- docs/bioformats-release-process.rst | 39 ++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index c324ab4..af4a3fa 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -85,6 +85,43 @@ An hourly cron job runs on our virtual machine and adds redirect from for exampl Close the milestone if any and add new one if needed. +Bio-Formats example release +--------------------------- + +Before making a release, merge all contributions on the ``master`` branch of `Bio-Formats Examples `_. + +The first operation to perform a Maven release is to bump the version out of +SNAPSHOT using the Maven versions plugin:: + + $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false + $ mvn versions:set-property -Dproperty=formats-gpl.version -DnewVersion=x.y.z -DgenerateBackupPoms=false + +Bump the ``version`` and ``formats-gpl`` in :file:`build.gradle`. + +Add and commit:: + + $ git add -u . + $ git commit -m "Bump release version to x.y.z" + + +A signed tag must be created for the released version using :command:`git tag -s`:: + + $ git tag -s -m "Tag version x.y.z" vx.y.z + +Revert to ``SNAPSHOT`` in :file:`pom.xml`:: + + $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false + +Revert the ``version`` to ``SNAPSHOT`` in :file:`build.gradle`. + +Both the `master` branch as well as the tag must be pushed upstream:: + + $ git push origin master vx.y.z + +This will trigger GitHub action builds, generate artifacts and upload +the artifacts to the `OME artifactory`_. + + Fiji Update site ---------------- @@ -94,7 +131,7 @@ The first operation to perform a Maven release is to bump the version out of SNAPSHOT using the Maven versions plugin, add and commit:: $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false - $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=.y.z -DgenerateBackupPoms=false + $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=x.y.z -DgenerateBackupPoms=false $ git add -u . $ git commit -m "Bump release version to x.y.z" $ git push origin master From 38c2320b0997a5387bb2efc0a5add3a924e6ab96 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 22 Aug 2024 10:22:52 +0100 Subject: [PATCH 10/16] fix double quote --- docs/bioformats-release-process.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index af4a3fa..29d07de 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -29,7 +29,7 @@ SNAPSHOT using the Maven versions plugin, add and commit:: $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false $ mvn versions:set-property -Dproperty=release.version -DnewVersion=x.y.z -DgenerateBackupPoms=false $ git add -u . - $ git commit -m “Bump release version to x.y.z” + $ git commit -m "Bump release version to x.y.z" A signed tag must be created for the released version using :command:`git tag -s`:: From 4b8fddfdf1067ed52a5ccd4119af571efc1f88f1 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 22 Aug 2024 10:27:25 +0100 Subject: [PATCH 11/16] indicate where to add new contributors --- docs/bioformats-release-process.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 29d07de..a8f6850 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -8,7 +8,7 @@ BioFormats release .. _Read The Docs: https://readthedocs.org/projects/bio-formats/builds/ .. _Data Repository: https://github.com/openmicroscopy/data_repo_config -This document describes the release process the `Bio-Formats`_ Java library. +This document describes the release process of the `Bio-Formats`_ Java library. The release process uses GitHub actions, make sure that the actions are active before pushing any tag. Before starting the release process, @@ -200,7 +200,7 @@ To make a release: - Update the version in `_config.yml `_ - Add a new entry under `_posts `_. The name of the post should be ``YYYY-MM-DD-omero-MAJOR-MINOR-PATCH.md`` e.g. ``2024-08-15-omero-5-6-13.md`` - Point to the post announcing the release in `bio-formats/downloads/index.html `_. - + - Add, in alphabetical order, new contributors to `_data/bio-formats.json `_ and `_data/contributors.json `_. A signed tag must be created using :command:`git tag -s`:: From 8e3a18613557e6a2c20c34e7c4d3f2d9019aab1c Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 22 Aug 2024 10:35:31 +0100 Subject: [PATCH 12/16] minor edits --- docs/bioformats-release-process.rst | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index a8f6850..151cee4 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -7,6 +7,7 @@ BioFormats release .. _Octave Docker: https://github.com/ome/bio-formats-octave-docker .. _Read The Docs: https://readthedocs.org/projects/bio-formats/builds/ .. _Data Repository: https://github.com/openmicroscopy/data_repo_config +.. _Bio-Formats homebrew: https://github.com/ome/homebrew-alt This document describes the release process of the `Bio-Formats`_ Java library. The release process uses GitHub actions, make sure that the actions are active before pushing any tag. @@ -24,7 +25,7 @@ Source code release Before making a new release, merge all contributions on the ``develop`` branch of `Bio-Formats`_. The first operation to perform a Maven release is to bump the version out of -SNAPSHOT using the Maven versions plugin, add and commit:: +``SNAPSHOT`` using the Maven versions plugin, add and commit:: $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false $ mvn versions:set-property -Dproperty=release.version -DnewVersion=x.y.z -DgenerateBackupPoms=false @@ -43,7 +44,7 @@ Revert to ``SNAPSHOT``, add and commit:: $ git add -u . $ git commit -m "Revert to snapshot" -Both the `develop` branch as well as the tag must be pushed upstream:: +Both the ``develop`` branch as well as the tag must be pushed upstream:: $ git push origin develop vx.y.z @@ -59,7 +60,7 @@ Documentation release Before making a new release, merge all contributions on the ``master`` branch of `Bio-Formats Documentation`_. The first operation to perform a Maven release is to bump the version out of -SNAPSHOT using the Maven versions plugin, add and commit:: +``SNAPSHOT`` using the Maven versions plugin, add and commit:: $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=x.y.z -DgenerateBackupPoms=false @@ -67,6 +68,9 @@ SNAPSHOT using the Maven versions plugin, add and commit:: $ git add -u . $ git commit -m "Bump release version to x.y.z" +A signed tag must be created for the released version using :command:`git tag -s`:: + + $ git tag -s -m "Tag version x.y.z" vx.y.z Revert to ``SNAPSHOT``, add and commit:: @@ -74,7 +78,7 @@ Revert to ``SNAPSHOT``, add and commit:: $ git add -u . $ git commit -m "Revert to snapshot" -Both the `master` branch as well as the tag must be pushed upstream:: +Both the ``master`` branch as well as the tag must be pushed upstream:: $ git push origin master vx.y.z @@ -91,7 +95,7 @@ Bio-Formats example release Before making a release, merge all contributions on the ``master`` branch of `Bio-Formats Examples `_. The first operation to perform a Maven release is to bump the version out of -SNAPSHOT using the Maven versions plugin:: +``SNAPSHOT`` using the Maven versions plugin:: $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false $ mvn versions:set-property -Dproperty=formats-gpl.version -DnewVersion=x.y.z -DgenerateBackupPoms=false @@ -114,7 +118,7 @@ Revert to ``SNAPSHOT`` in :file:`pom.xml`:: Revert the ``version`` to ``SNAPSHOT`` in :file:`build.gradle`. -Both the `master` branch as well as the tag must be pushed upstream:: +Both the ``master`` branch as well as the tag must be pushed upstream:: $ git push origin master vx.y.z @@ -128,7 +132,7 @@ Fiji Update site Before making a release, merge all contributions on the ``master`` branch of `Bio-Formats Fiji `_. The first operation to perform a Maven release is to bump the version out of -SNAPSHOT using the Maven versions plugin, add and commit:: +``SNAPSHOT`` using the Maven versions plugin, add and commit:: $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=x.y.z -DgenerateBackupPoms=false @@ -150,6 +154,8 @@ Revert to ``SNAPSHOT``, add, commit and push to origin:: Homebrew -------- +Before making a new release, merge all contributions on the `master` branch (rare) of `Bio-Formats homebrew`_. + - Update the `Bio-Formats formula `_ by pointing to the ``bioformats-RELEASE.zip`` and update the ``sha256`` value. The ``sha256`` can be found in the ``SHASUM`` file under https://downloads.openmicroscopy.org/bio-formats/RELEASE/artifacts/. - Update the version and sha256 in the ``.rb`` file corresponding to the current release. @@ -190,7 +196,6 @@ A signed tag must be created for the released version using :command:`git tag -s $ git push origin master - Website release --------------- @@ -218,8 +223,8 @@ Announcement ------------ - Announce the release on `image.sc`_ using the ``Announcements`` category after checking that the website has been deployed. - - Confocal email - - X/linkedin + - Announce on the Confocal email + - Announce on X and linkedin Post Release From d8d1d140a4da8566d2ce582c56c40ff091e29624 Mon Sep 17 00:00:00 2001 From: jean-marie burel Date: Thu, 22 Aug 2024 13:14:05 +0100 Subject: [PATCH 13/16] Update docs/bioformats-release-process.rst Co-authored-by: David Gault --- docs/bioformats-release-process.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 151cee4..ab6e8aa 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -89,7 +89,7 @@ An hourly cron job runs on our virtual machine and adds redirect from for exampl Close the milestone if any and add new one if needed. -Bio-Formats example release +Bio-Formats examples release --------------------------- Before making a release, merge all contributions on the ``master`` branch of `Bio-Formats Examples `_. From 3f0843aea4c9769a8799366fb3229d9ef1694e04 Mon Sep 17 00:00:00 2001 From: jean-marie burel Date: Thu, 22 Aug 2024 13:14:23 +0100 Subject: [PATCH 14/16] Update docs/bioformats-release-process.rst Co-authored-by: David Gault --- docs/bioformats-release-process.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index ab6e8aa..63f76a4 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -41,6 +41,7 @@ A signed tag must be created for the released version using :command:`git tag -s Revert to ``SNAPSHOT``, add and commit:: $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false + $ mvn versions:set-property -Dproperty=release.version -DnewVersion=x.y.z-SNAPSHOT -DgenerateBackupPoms=false $ git add -u . $ git commit -m "Revert to snapshot" From 7fb9afe0f7db58eae810886a94aa50f360dea4dd Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 22 Aug 2024 13:31:14 +0100 Subject: [PATCH 15/16] swap examples and doc release --- docs/bioformats-release-process.rst | 61 +++++++++++++++-------------- 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 63f76a4..9b4112c 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -55,77 +55,78 @@ An hourly cron job runs on our virtual machine and copy the artifacts published Close the milestone if any and add new one if needed. -Documentation release ---------------------- -Before making a new release, merge all contributions on the ``master`` branch of `Bio-Formats Documentation`_. +Bio-Formats examples release +--------------------------- + +Before making a release, merge all contributions on the ``master`` branch of `Bio-Formats Examples `_. The first operation to perform a Maven release is to bump the version out of -``SNAPSHOT`` using the Maven versions plugin, add and commit:: +``SNAPSHOT`` using the Maven versions plugin:: $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false - $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=x.y.z -DgenerateBackupPoms=false - $ mvn versions:set-property -Dproperty=bio-formats-examples.version -DnewVersion=x.y.z -DgenerateBackupPoms=false + $ mvn versions:set-property -Dproperty=formats-gpl.version -DnewVersion=x.y.z -DgenerateBackupPoms=false + +Bump the ``version`` and ``formats-gpl`` in :file:`build.gradle`. + +Add and commit:: + $ git add -u . $ git commit -m "Bump release version to x.y.z" + A signed tag must be created for the released version using :command:`git tag -s`:: $ git tag -s -m "Tag version x.y.z" vx.y.z -Revert to ``SNAPSHOT``, add and commit:: +Revert to ``SNAPSHOT`` in :file:`pom.xml`:: $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false - $ git add -u . - $ git commit -m "Revert to snapshot" + +Revert the ``version`` to ``SNAPSHOT`` in :file:`build.gradle`. Both the ``master`` branch as well as the tag must be pushed upstream:: $ git push origin master vx.y.z +This will trigger GitHub action builds, generate artifacts and upload +the artifacts to the `OME artifactory`_. -The documentation is built and published on `Read The Docs`_. - -An hourly cron job runs on our virtual machine and adds redirect from for example `docs.openmicroscopy.org/bio-formats/7.3.1 `_ to `bio-formats.readthedocs.io/en/v7.3.1/ `_. - -Close the milestone if any and add new one if needed. -Bio-Formats examples release ---------------------------- +Documentation release +--------------------- -Before making a release, merge all contributions on the ``master`` branch of `Bio-Formats Examples `_. +Before making a new release, merge all contributions on the ``master`` branch of `Bio-Formats Documentation`_. The first operation to perform a Maven release is to bump the version out of -``SNAPSHOT`` using the Maven versions plugin:: +``SNAPSHOT`` using the Maven versions plugin, add and commit:: $ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false - $ mvn versions:set-property -Dproperty=formats-gpl.version -DnewVersion=x.y.z -DgenerateBackupPoms=false - -Bump the ``version`` and ``formats-gpl`` in :file:`build.gradle`. - -Add and commit:: - + $ mvn versions:set-property -Dproperty=bioformats.version -DnewVersion=x.y.z -DgenerateBackupPoms=false + $ mvn versions:set-property -Dproperty=bio-formats-examples.version -DnewVersion=x.y.z -DgenerateBackupPoms=false $ git add -u . $ git commit -m "Bump release version to x.y.z" - A signed tag must be created for the released version using :command:`git tag -s`:: $ git tag -s -m "Tag version x.y.z" vx.y.z -Revert to ``SNAPSHOT`` in :file:`pom.xml`:: +Revert to ``SNAPSHOT``, add and commit:: $ mvn versions:set -DnewVersion=x.y.t-SNAPSHOT -DgenerateBackupPoms=false - -Revert the ``version`` to ``SNAPSHOT`` in :file:`build.gradle`. + $ git add -u . + $ git commit -m "Revert to snapshot" Both the ``master`` branch as well as the tag must be pushed upstream:: $ git push origin master vx.y.z -This will trigger GitHub action builds, generate artifacts and upload -the artifacts to the `OME artifactory`_. +The documentation is built and published on `Read The Docs`_. + +An hourly cron job runs on our virtual machine and adds redirect from for example `docs.openmicroscopy.org/bio-formats/7.3.1 `_ to `bio-formats.readthedocs.io/en/v7.3.1/ `_. + +Close the milestone if any and add new one if needed. Fiji Update site ---------------- From e3ec3ed9eb6de4f60a5c295fed61fa14c52c5445 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Fri, 23 Aug 2024 07:19:41 +0100 Subject: [PATCH 16/16] add testing section --- docs/bioformats-release-process.rst | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 9b4112c..3808d57 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -56,8 +56,26 @@ An hourly cron job runs on our virtual machine and copy the artifacts published Close the milestone if any and add new one if needed. +Testing the artifacts +--------------------- + +To test the artifacts published, + - Test the `bio-formats-command-line-tools `_. + - Test `MATLAB (only) `_. + - Test `Fiji Plugin `_ + - Check the schema version using the command line tools:: + $ ./bfconvert B.ome.tiff + $ ./tiffcomment B.ome.tiff + Check that the schema version in OME-XML be ``2016-06`` + + +If an error occurs during the testing: + - Delete the release and the tag on GitHub. + - Delete the artifacts on `OME artifactory`_. + - Delete the folder corresponding to the latest release under `Bio-Formats Downloads`_, if it has already been created. + Bio-Formats examples release ---------------------------- +---------------------------- Before making a release, merge all contributions on the ``master`` branch of `Bio-Formats Examples `_.