Skip to content

chore: Expand docs for releasing clients and client docs #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markstory merged 1 commit into from
Feb 17, 2026
Merged

chore: Expand docs for releasing clients and client docs #555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
[![codecov](https://codecov.io/gh/getsentry/taskbroker/graph/badge.svg?token=RFA2pVkzhl)](https://codecov.io/gh/getsentry/taskbroker)

Taskbroker provides a Kafka consumer, RPC interface, and inflight task storage
that form the core engine of asynchronous task execution at Sentry.
that form the core engine of asynchronous task execution at Sentry. This repository
also contains client libraries for python.

## High level overview

Expand Down Expand Up @@ -93,3 +94,13 @@ make style
# Fix formatting and lint issues
make format
```

## Python Client

See the [python client README](./clients/python/README.md) for more information.

### Releasing clients

1. Use the [release client libraries workflow](https://github.com/getsentry/taskbroker/actions/workflows/release-client.yml)
2. Choose 'Run workflow' and enter a version number in.
3. This will use craft + getsentry/publish to add packages to both internal and public pypi.
5 changes: 5 additions & 0 deletions clients/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,8 @@ This package provides python client libraries for taskbroker. The client librari
## Example application

You can find an example application in the `src/examples` directory.

## Client documentation

- [User-guide for taskbroker-client](https://develop.sentry.dev/backend/application-domains/tasks/)
- [Protobuf docs](https://getsentry.github.io/sentry-protos/sentry_protos.taskbroker.v1.html)
Loading