Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add initial RELEASE.md doc to describe release steps #101

Merged
merged 2 commits into from
Sep 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -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 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 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).
* Merge the generated PR.