Skip to content

Commit 992e98a

Browse files
committed
Add releasing docs
1 parent c65e785 commit 992e98a

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

docs/wiki/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@
2525
* [API](generated_apis.md)
2626
* Builders
2727
* [Github actions](./githubactions.md)
28+
* [Releasing](./release.md)

docs/wiki/_sidebar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@
2626
* [API](generated_apis.md)
2727
* Builders
2828
* [Github actions](./githubactions.md)
29+
* [Releasing](./release.md)

docs/wiki/release.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Releasing js-sdk process
2+
3+
- Create a branch `development_VERSION`
4+
- Verify code on development branch `make tests`
5+
- Generate documentation `make docs`
6+
- Update js-sdk version in `pyproject.toml` to the branch version
7+
- Create a pull request aganist the development branch
8+
- Merge the pull request into development
9+
- Create a pull request from development against the master branch
10+
- Merge the pull request into master
11+
- Tag the new version (can be done from the github UI) easier for release notes.
12+
- Build the package `poetry build`
13+
- Publish the package to `pypi.org` using `poetry publish`

0 commit comments

Comments
 (0)