From f230ba0b3914048972b8e8602c9fe4240aeb21bd Mon Sep 17 00:00:00 2001 From: dalthviz <16781833+dalthviz@users.noreply.github.com> Date: Mon, 9 Sep 2024 09:50:27 -0500 Subject: [PATCH 1/2] Add initial RELEASE.md doc to describe release steps --- RELEASE.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..18adac0 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,21 @@ +# Release Procedure + +Here you can find some information about how to trigger a new release over PyPI and subsequent `conda-forge` update. + +## PyPI + +To release on PyPI you will need to create a new tag. To do so you can: + +* Create a [new GitHub release](https://github.com/napari/napari-plugin-manager/releases/new) +* Use over the new release GitHub page the `Choose a tag` dropdown to create a new tag (it should be something like `vX.Y.Z` incrementing the major, minor or patch number as required). +* Once the tag is defined you should be able to click `Generate release notes`. +* Put as release title the tag that was created (`vX.Y.Z`). +* Publish the release, check that the deploy step was run sucessfully and that the reletad new version is available over [PyPI](https://pypi.org/project/napari-plugin-manager/#history) + +## conda-forge + +To update the `conda-forge` package you will need to update the [`napari-plugin-manager` feedstock](https://github.com/conda-forge/napari-plugin-manager-feedstock). **If a new version is already available from PyPI**, you can: + +* Create an issue over the feedstock with the title: [`@conda-forge-admin, please update version`](https://conda-forge.org/docs/maintainer/infrastructure/#conda-forge-admin-please-update-version) +* Tweak the generated PR if necessary (dependencies changes for example). +* Merge the generated PR. From 43c9df3e1636112963066480b98b2c95f7baf7a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Althviz=20Mor=C3=A9?= <16781833+dalthviz@users.noreply.github.com> Date: Mon, 9 Sep 2024 11:33:37 -0500 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: jaimergp --- RELEASE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 18adac0..e2ddcc2 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -10,11 +10,11 @@ To release on PyPI you will need to create a new tag. To do so you can: * Use over the new release GitHub page the `Choose a tag` dropdown to create a new tag (it should be something like `vX.Y.Z` incrementing the major, minor or patch number as required). * Once the tag is defined you should be able to click `Generate release notes`. * Put as release title the tag that was created (`vX.Y.Z`). -* Publish the release, check that the deploy step was run sucessfully and that the reletad new version is available over [PyPI](https://pypi.org/project/napari-plugin-manager/#history) +* Publish the release, check that the deploy step was run successfully and that the new version is available at [PyPI](https://pypi.org/project/napari-plugin-manager/#history) ## conda-forge -To update the `conda-forge` package you will need to update the [`napari-plugin-manager` feedstock](https://github.com/conda-forge/napari-plugin-manager-feedstock). **If a new version is already available from PyPI**, you can: +To update the `conda-forge` package you will need to update the [`napari-plugin-manager` feedstock](https://github.com/conda-forge/napari-plugin-manager-feedstock). **If a new version is already available from PyPI**, you can either wait for the automated PR or trigger one manually: * Create an issue over the feedstock with the title: [`@conda-forge-admin, please update version`](https://conda-forge.org/docs/maintainer/infrastructure/#conda-forge-admin-please-update-version) * Tweak the generated PR if necessary (dependencies changes for example).