Skip to content

Commit f9fa1da

Browse files
Copilotkjy5
andauthored
docs: add release process documentation (#90)
* Initial plan * docs: add Deploying New Releases section to development documentation Co-authored-by: kjy5 <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: kjy5 <[email protected]>
1 parent 1f22511 commit f9fa1da

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/home/development.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,25 @@ hatch run check
2626
```
2727

2828
to run pyright type checking.
29+
30+
## Deploying New Releases
31+
32+
Deploying a new release is done automatically via GitHub Actions. To deploy a new release:
33+
34+
1. Update the version number in `src/vbl_aquarium/__about__.py`
35+
2. Commit and push the version change to the `main` branch
36+
3. Create and push a tag with the version number:
37+
38+
```bash
39+
git tag v<version>
40+
git push origin v<version>
41+
```
42+
43+
The [release workflow](https://github.com/VirtualBrainLab/vbl-aquarium/blob/main/.github/workflows/release.yml) will automatically:
44+
45+
- Build the package using Hatch
46+
- Publish the package to [PyPI](https://pypi.org/project/vbl-aquarium/)
47+
- Create a GitHub release with auto-generated release notes
48+
49+
!!! note
50+
Pre-release versions (containing `a`, `b`, `c`, or `d` in the version string) will be marked as pre-releases on GitHub.

0 commit comments

Comments
 (0)