Skip to content

Commit

Permalink
Prepare release 0.1.0 (#17)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
brandur authored Jul 5, 2024
1 parent b9a760a commit 779dfa0
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.1.0] - 2024-07-04

### Added

- Initial release, supporting insertion through [SQLAlchemy](https://www.sqlalchemy.org/) and its underlying Postgres drivers like [psycopg2](https://pypi.org/project/psycopg2/) .
- 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).
25 changes: 25 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,28 @@ $ rye fmt
```

Rye uses [Ruff](https://github.com/astral-sh/ruff) under the hood for code formatting.

## Publish package

1. Pull existing `master` and tags, choose a version, and create a branch:

```shell
git checkout master && git pull --rebase
export VERSION=v0.x.0
git checkout -b $USER-$VERSION
```

2. Update `CHANGELOG.md` and `pyproject.toml` to the new version number, and open a pull request. Get it reviewed and merged.

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:

```shell
git pull origin master
rye build
rye publish
git tag $VERSION
git push --tags
```
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.
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ name = "riverqueue"
version = "0.1.0"
description = "Add your description here"
authors = [
{ name = "Eric Hauser", email = "[email protected]" }
{ name = "Eric Hauser", email = "[email protected]" },
{ name = "Brandur Leach", email = "[email protected]" }
]
dependencies = [
"sqlalchemy>=2.0.30",
Expand Down

0 comments on commit 779dfa0

Please sign in to comment.