From 523d7dba0e8cdd1abe0c76359bb9cbe417c1d1a9 Mon Sep 17 00:00:00 2001
From: Brian Healy <42810347+bfhealy@users.noreply.github.com>
Date: Mon, 1 Apr 2024 09:49:19 -0500
Subject: [PATCH] Add pypi release to developer docs (#562)

---
 doc/developer.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/developer.md b/doc/developer.md
index 68b1815..0a9e6cf 100644
--- a/doc/developer.md
+++ b/doc/developer.md
@@ -162,6 +162,12 @@ Developers may merge `main` into their branch as many times as they want to.
 
 1. Once the pull request has been reviewed and approved by at least one team member, it will be merged into `scope`.
 
+#### Releasing on PyPI
+
+As new features are added to the code, maintainers should occasionally initiate a new release of the `scope-ml` [PyPI](https://pypi.org/project/scope-ml/) package. To do this, first bump the version of the package in `pyproject.toml` and `scope/__init__.py` to the intended `vX.Y.Z` format. Then, navigate to "Releases" in the SCoPe GitHub repo and click "Draft a new release". Enter the version number in "Choose a tag" and click "Generate release notes". It is also advisable to check the box creating a discussion for the release before clicking "Publish release".
+
+Upon release, the `publish-to-pypi.yml` workflow will use GitHub Actions to publish a new version of the package to PyPI automatically. **Note that if the version number has not yet been manually updated in `pyproject.toml`, this workflow will fail.**
+
 ### Contributing Field Guide sections
 
 If you would like to contribute a Field Guide section, please follow the steps below.