Skip to content

Commit 189ae2d

Browse files
committed
Chore: Update release instructions
1 parent 2d77101 commit 189ae2d

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

DEVELOP.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,26 @@ Format code:
3434

3535
## Preparing a release
3636

37-
In the release branch:
38-
39-
- Update `__version__` in `src/crate/client/__init__.py`
40-
- Add a section for the new version in the `CHANGES.txt` file
41-
- Commit your changes with a message like \"prepare release x.y.z\"
42-
- Push to origin/\<release_branch\>
43-
- Create a tag by running `./devtools/create_tag.sh`. This will
44-
trigger a GitHub action which releases the new version to PyPi.
45-
4637
On branch `main`:
4738

48-
- Update the release notes to reflect the release
39+
- Add a section for the new version in the `CHANGES.md` file
40+
- Commit your changes with a message like \"Release x.y.z\"
41+
- Push to origin/\<release_branch\>
42+
- Create a tag, and push to remote.
43+
```shell
44+
git tag v0.0.1
45+
git push --tags
46+
```
47+
- Build package, and upload to PyPI.
48+
```shell
49+
poe release
50+
```
51+
52+
On GitHub:
53+
54+
- Designate a new release on GitHub, copying in the relevant section
55+
from the CHANGELOG.
56+
https://github.com/crate-workbench/sqlalchemy-cratedb/releases
4957

5058

5159
## Writing documentation

0 commit comments

Comments
 (0)