You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPER.md
+19-8Lines changed: 19 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,11 +32,22 @@ nox
32
32
33
33
In order to run the examples you will need to install `rsxml`. If you want that installed version to be editable, you can use `pip install -e .` from the root rsxml directory.
34
34
35
-
## Deploying
36
-
37
-
There are two scripts to deploy the package to PyPI:
38
-
39
-
-`build.sh` - builds the package and puts it in `dist/`.
40
-
-`deploy.sh` - Push the package to the PyPI server. This script requires `PYPI_TOKEN` environment variable.
41
-
42
-
The scripts will automatically install `uv` if it is not present.
35
+
## Release Process
36
+
37
+
1.**Update Changelog**:
38
+
- Move the content from `[Unreleased]` to a new section with the version number and date in [CHANGELIST.md](CHANGELIST.md).
39
+
- Ensure `[Unreleased]` is empty but preserved at the top.
40
+
41
+
2.**Bump Version**:
42
+
- Update the version number in [src/rsxml/__version__.py](src/rsxml/__version__.py).
43
+
44
+
3.**Tag and Push**:
45
+
- Commit the changes (changelog and version bump).
46
+
- Create a git tag matching the version (e.g., `v2.2.0`) NOTE THE "v" it is important that the tag start with this.
47
+
- Push the commit and the tag to GitHub:
48
+
```bash
49
+
git commit -am "Bump version to 2.2.0"
50
+
git tag v2.2.0
51
+
git push && git push --tags
52
+
```
53
+
- The [Publish to PyPI](.github/workflows/pypi-publish.yml) GitHub Action will automatically build and deploy the package.
0 commit comments