From 46d0c6b606a62b27d6e5395e438be5870179826d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 27 Dec 2025 23:02:03 +0000 Subject: [PATCH 1/2] Initial plan From 720b3a43cd3d7968ac56cccf5ec48c2a8e869c17 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 27 Dec 2025 23:05:48 +0000 Subject: [PATCH 2/2] docs: add Deploying New Releases section to development documentation Co-authored-by: kjy5 <82800265+kjy5@users.noreply.github.com> --- docs/home/development.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/home/development.md b/docs/home/development.md index 13ef5b4..6e507ae 100644 --- a/docs/home/development.md +++ b/docs/home/development.md @@ -26,3 +26,25 @@ hatch run check ``` to run pyright type checking. + +## Deploying New Releases + +Deploying a new release is done automatically via GitHub Actions. To deploy a new release: + +1. Update the version number in `src/vbl_aquarium/__about__.py` +2. Commit and push the version change to the `main` branch +3. Create and push a tag with the version number: + +```bash +git tag v +git push origin v +``` + +The [release workflow](https://github.com/VirtualBrainLab/vbl-aquarium/blob/main/.github/workflows/release.yml) will automatically: + +- Build the package using Hatch +- Publish the package to [PyPI](https://pypi.org/project/vbl-aquarium/) +- Create a GitHub release with auto-generated release notes + +!!! note + Pre-release versions (containing `a`, `b`, `c`, or `d` in the version string) will be marked as pre-releases on GitHub.