Skip to content

Commit 9f6ed7e

Browse files
committed
Bump version to v0.0.3
1 parent 3ea87b1 commit 9f6ed7e

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,40 @@ If you want to make changes to the SDK and test it locally:
2525

2626
By installing in editable mode, any changes you make to the SDK will immediately reflect in your tests without needing to reinstall the package.
2727

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+
2862
## **Disclaimer**
2963
🚨 **This project is a work in progress and should not be used in production systems.**
3064
Expect breaking changes as the SDK evolves.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "jup-ag-sdk"
3-
version = "0.0.2"
3+
version = "0.0.3"
44
description = "Python SDK for Jupiter Exchange APIs."
55
authors = ["Fiji <[email protected]>"]
66
license = "MIT"

0 commit comments

Comments
 (0)