Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.56 KB
Raw

Contributing to Postgres Message Queue (PGMQ)

Installation

The fastest way to get started is by running the Tembo docker image, where PGMQ comes pre-installed.

docker run -d --name postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io/tembo/pgmq-pg:latest

Building from source

PGMQ requires the postgres-server-dev package to build. For example, to install version 14 on ubuntu:

sudo apt-get install postgres-server-dev-14

Clone the repo and change into the directory.

git clone https://github.com/tembo-io/pgmq.git
cd pgmq

Install to a pre-existing Postgres

make
make install

Finally, you can create the extension and get started with the example in the README.md.

CREATE EXTENSION pgmq cascade;

Running tests

Once you have a postgres instance with the extension installed, run:

DATABASE_URL=postgres:postgres@localhost:5432/postgres make test

Releases

PGMQ Postgres Extension releases are automated through a Github workflow. The compiled binaries are publish to and hosted at pgt.dev. To create a release, create a new tag follow a valid semver, then create a release with the same name. Auto-generate the release notes and/or add more relevant details as needed. See subdirectories for the Rust and Python SDK release processes.