Skip to content

Commit 6e4a13f

Browse files
committed
Add release docs
1 parent 071ffa1 commit 6e4a13f

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

RELEASE.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Release process
2+
3+
1. Bump the version number in `setup.cfg` and `singlestoredb/__init__.py` using
4+
semantic versioning rules: minor bump for new features, patch bump for
5+
bug fixes.
6+
7+
2. Add release notes to `docs/src/whatsnew.rst`.
8+
9+
3. Run `SINGLESTOREDB_URL=root:@db-server:db-port make html` in `docs/src` to
10+
generate documentation. You will need `sphinx` and `sphinx_rtd_theme` installed
11+
for this step. You also need a SingleStoreDB server running at the given
12+
IP and port to run samples against.
13+
14+
4. Commit all changed files with a commit like "Prepare for vX.X.X release".
15+
16+
5. The coverage tests will be triggered by the push, but you should also run
17+
`Smoke test` workflow manually which does basic tests on all supported versions
18+
of Python.
19+
20+
6. Once all workflows are clean, create a new Github release with the name
21+
"SingleStoreDB vX.X.X" and set the generated tag to the matching version
22+
number. Add the release notes from the `whatsnew.rst` file to the release
23+
notes. Creating the release will run the `Public packages` workflow which
24+
builds the packages and pubsishes them to PyPI.

0 commit comments

Comments
 (0)