Skip to content

Commit 779dfa0

Browse files
authored
Prepare release 0.1.0 (#17)
There's still a few more changes I want to make before being fully finished on River Python's first pass, but for now we have enough to try a full publish to PyPI, so try for release 0.1.0
1 parent b9a760a commit 779dfa0

File tree

3 files changed

+30
-2
lines changed

3 files changed

+30
-2
lines changed

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [0.1.0] - 2024-07-04
11+
1012
### Added
1113

12-
- Initial release, supporting insertion through [SQLAlchemy](https://www.sqlalchemy.org/) and its underlying Postgres drivers like [psycopg2](https://pypi.org/project/psycopg2/) .
14+
- Initial release, supporting insertion through [SQLAlchemy](https://www.sqlalchemy.org/) and its underlying Postgres drivers like [psycopg2](https://pypi.org/project/psycopg2/) or [asyncpg](https://github.com/MagicStack/asyncpg) (for async).

docs/development.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,28 @@ $ rye fmt
6161
```
6262

6363
Rye uses [Ruff](https://github.com/astral-sh/ruff) under the hood for code formatting.
64+
65+
## Publish package
66+
67+
1. Pull existing `master` and tags, choose a version, and create a branch:
68+
69+
```shell
70+
git checkout master && git pull --rebase
71+
export VERSION=v0.x.0
72+
git checkout -b $USER-$VERSION
73+
```
74+
75+
2. Update `CHANGELOG.md` and `pyproject.toml` to the new version number, and open a pull request. Get it reviewed and merged.
76+
77+
3. Pull down the merged pull request, build the project (goes to `dist/`), publish it to PyPI, cut a tag for the new version, and push it to GitHub:
78+
79+
```shell
80+
git pull origin master
81+
82+
rye build
83+
rye publish
84+
85+
git tag $VERSION
86+
git push --tags
87+
```
88+
4. Cut a new GitHub release by visiting [new release](https://github.com/riverqueue/riverqueue-python/releases/new), selecting the new tag, and copying in the version's `CHANGELOG.md` content as the release body.

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ name = "riverqueue"
33
version = "0.1.0"
44
description = "Add your description here"
55
authors = [
6-
{ name = "Eric Hauser", email = "[email protected]" }
6+
{ name = "Eric Hauser", email = "[email protected]" },
7+
{ name = "Brandur Leach", email = "[email protected]" }
78
]
89
dependencies = [
910
"sqlalchemy>=2.0.30",

0 commit comments

Comments
 (0)