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: README.md
+34Lines changed: 34 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,40 @@ If you want to make changes to the SDK and test it locally:
25
25
26
26
By installing in editable mode, any changes you make to the SDK will immediately reflect in your tests without needing to reinstall the package.
27
27
28
+
## **Making a New Release**
29
+
To create and publish a new release of the package to PyPI:
30
+
31
+
1.**Update the Version:**
32
+
- Update the version in your `pyproject.toml` file following [semantic versioning](https://semver.org/), e.g., `0.0.1` → `0.1.0` for a minor update.
33
+
34
+
2.**Commit the Changes:**
35
+
- Commit and push the version update to the main branch:
36
+
```sh
37
+
git add pyproject.toml
38
+
git commit -m "Bump version to vX.Y.Z"
39
+
git push origin main
40
+
```
41
+
42
+
3. **Create a Tag:**
43
+
- Tag the commit with the new version:
44
+
```sh
45
+
git tag vX.Y.Z
46
+
git push origin vX.Y.Z
47
+
```
48
+
49
+
Replace `vX.Y.Z` with the actual version number.
50
+
51
+
4. **GitHub Actions Workflow:**
52
+
- When the tag is pushed, the `release.yml` GitHub Actions workflow will automatically:
53
+
- Build the package using Poetry.
54
+
- Publish the package to PyPI.
55
+
56
+
5. **Confirm the Release:**
57
+
- Check [PyPI](https://pypi.org/) to ensure the new version has been published successfully.
58
+
59
+
6. **Important Note:**
60
+
- Ensure your PyPI API token is added as a secret (`PYPI_API_TOKEN`) in the repository's GitHub settings under **Secrets and variables** > **Actions**.
61
+
28
62
## **Disclaimer**
29
63
🚨 **This project is a work in progress and should not be used in production systems.**
0 commit comments