Skip to content

Commit 8dbc27b

Browse files
committed
added instructions on how to create a new release to be deployed to pypi
1 parent 7d17d2e commit 8dbc27b

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

.github/pypi_deploy.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# How to release a new version to PyPi
2+
3+
1. Update the version number in [`citylearn.__init__`](../citylearn/__init__.py). The version format is `X.Y.Z` where `X` is bumped up for major releases that will come with breaking changes for previous versions, `Y` is bumped up for new features that do not cause breaking changes and `Z` is bumped up for bug fixes.
4+
5+
2. Commit and push the updated `citylearn.__init__` file:
6+
```shell
7+
git add citylearn/__init__.py
8+
git commit -m "Updated version to vX.Y.Z"
9+
git push
10+
```
11+
12+
3. Create a new tag for the updated version and push to the remote:
13+
```shell
14+
git tag vX.Y.Z -m "<A message describing the changes introduced in the new tag>"
15+
git push upstream --tags
16+
```
17+
18+
4. Go to the [tags page on GitHub](https://github.com/intelligent-environments-lab/CityLearn/tags) and create a new release for the new `vX.Y.Z` tag. Once the release has been created, the [`workflows/pypi_deply.yml`](workflows/pypi_deploy.yml) `GitHub Actions` will be automatically triggered to upload a new release to the [CityLearn PyPi project](https://pypi.org/project/CityLearn/).

0 commit comments

Comments
 (0)