Skip to content

docs: add release process documentation #90

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.

Sign up for GitHub

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

Merged
kjy5 merged 2 commits into from
Dec 27, 2025
Merged

docs: add release process documentation #90

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46d0c6b
Initial plan
Copilot Dec 27, 2025
720b3a4
docs: add Deploying New Releases section to development documentation
Copilot Dec 27, 2025
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
22 changes: 22 additions & 0 deletions docs/home/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<version>
git push origin v<version>
```

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.