Skip to content

Commit 6b64619

Browse files
committed
Chore: Update development documentation
1 parent 87f366d commit 6b64619

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

DEVELOP.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,23 @@ Format code:
3636

3737
On branch `main`:
3838

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\>
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`.
4241
- Create a tag, and push to remote.
42+
This will trigger a GitHub action which releases the new version to PyPi.
4343
```shell
44-
git tag v0.0.1
44+
git tag 0.36.1
4545
git push --tags
4646
```
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
47+
- On GitHub, designate a new release, copying in the relevant section
5548
from the CHANGELOG.
5649
https://github.com/crate-workbench/sqlalchemy-cratedb/releases
5750

51+
Optionally, build the package and upload to PyPI manually.
52+
```shell
53+
poe release
54+
```
55+
5856

5957
## Writing documentation
6058

0 commit comments

Comments
 (0)