From faf2fb3b5b4bfcd5d98f7da8ebd715dde0dcf4f2 Mon Sep 17 00:00:00 2001 From: Adam Hendel Date: Wed, 12 Nov 2025 19:52:46 -0600 Subject: [PATCH] update docs --- CONTRIBUTING.md | 22 +++++++++++----------- META.json.in | 10 +++++----- Makefile | 2 +- README.md | 10 ++++------ Trunk.toml | 14 -------------- 5 files changed, 21 insertions(+), 37 deletions(-) delete mode 100644 Trunk.toml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 328b470..aa8bdbd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,10 +2,10 @@ ## Installation -The fastest way to get started is by running the Tembo docker image, where `pg_later` and its dependencies come pre-installed. +The fastest way to get started is by running the docker image, where `pg_later` and its dependencies come pre-installed. ```bash -docker run -d --name pglater-pg -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io/tembo/pglater-pg:latest +docker run -d --name pglater-pg -e POSTGRES_PASSWORD=postgres -p 5432:5432 ghcr.io/chuckhend/pglater-pg:latest ``` ## Building from source @@ -14,20 +14,20 @@ docker run -d --name pglater-pg -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay. To build `pg_later` from source, you need * A toolchain capable of building Postgres -* Rust toolchain -* [pgmq](https://github.com/tembo-io/pgmq). +* [Rust](https://rust-lang.org/tools/install/) toolchain +* [pgmq](https://github.com/pgmq/pgmq). Once you have those pre-requisites, you need to setup `pgrx`. ```bash # Find the version of PGRX to install from in Cargo.toml -cargo install --locked cargo-pgrx --version 0.9.8 +cargo install --locked cargo-pgrx --version 0.16.1 ``` Clone the repo and change into the directory. ```bash -git clone https://github.com/tembo-io/pg_later.git +git clone https://github.com/chuckhend/pg_later.git cd pg_later ``` @@ -66,7 +66,7 @@ Initialize `cargo-pgrx`, and tell it the path to the your `pg_config`. For examp if `pg_config` is on your `$PATH` and you have Postgres 15, you can run: ```bash -cargo pgrx init --pg15=`which pg_config` +cargo pgrx init --pg18=`which pg_config` ``` Then, to install the release build, you can simply run: ``` @@ -83,13 +83,13 @@ cargo pgrx init **Note**: Make sure you build and install `pgmq` against the postgres installation you want to build against (`PG_CONFIG` in `~/.pgrx/PG_VERSION/pgrx-install/bin/pg_config` -and `PGDATA` in `/Users//.pgrx/data-PG_MAJOR_VERSION`). Refer to the [pgmq installation instructions](https://github.com/tembo-io/pgmq/blob/main/CONTRIBUTING.md#building-from-source). +and `PGDATA` in `/Users//.pgrx/data-PG_MAJOR_VERSION`). Refer to the [pgmq installation instructions](https://github.com/pgmq/pgmq/blob/main/CONTRIBUTING.md#building-from-source). Then, you can use the run command, which will build and install the extension and drop you into psql: ```bash -cargo pgrx run pg15 +cargo pgrx run pg18 ``` Finally, you can create the extension and get started with the example in the [README.md](README.md). @@ -100,7 +100,7 @@ CREATE EXTENSION pg_later cascade; # Releases and versioning -`pg_later` Postgres Extension releases are automated through a [Github workflow](https://github.com/tembo-io/pg_later/blob/main/.github/workflows/pg_later_ext.yml). -The compiled binaries are publish to and hosted at [pgt.dev](https://pgt.dev). To create a release, create a new tag follow a valid [semver](https://semver.org/), then create a release with the same name. +`pg_later` Postgres Extension releases are automated through a [Github workflow](https://github.com/chuckhend/pg_later/blob/main/.github/workflows/pg_later_ext.yml). +To create a release, create a new tag follow a valid [semver](https://semver.org/), then create a release with the same name. This release must match the version found in Cargo.toml. Auto-generate the release notes and/or add more relevant details as needed. diff --git a/META.json.in b/META.json.in index 0614b44..31e72fa 100644 --- a/META.json.in +++ b/META.json.in @@ -1,10 +1,10 @@ { "name": "pg_later", "abstract": "Run queries now and get results later", - "description": "A postgres extension to execute queries asynchronously built on pgmq", + "description": "A postgres extension to execute queries asynchronously. Built on pgmq.", "version": "@CARGO_VERSION@", "maintainer": [ - "Tembo " + "Adam " ], "license": "postgresql", "provides": { @@ -25,11 +25,11 @@ }, "resources": { "bugtracker": { - "web": "https://github.com/tembo-io/pg_later/issues/" + "web": "https://github.com/chuckhend/pg_later/issues/" }, "repository": { - "url": "git://github.com/tembo-io/pg_later.git", - "web": "https://github.com/tembo-io/pg_later/", + "url": "git://github.com/chuckhend/pg_later.git", + "web": "https://github.com/chuckhend/pg_later/", "type": "git" } }, diff --git a/Makefile b/Makefile index 3c2e588..6245a5d 100644 --- a/Makefile +++ b/Makefile @@ -27,7 +27,7 @@ clean: @rm -rf META.json $(DISTNAME)-$(DISTVERSION).zip install-pgmq: - git clone https://github.com/tembo-io/pgmq.git && \ + git clone https://github.com/pgmq/pgmq.git && \ cd pgmq/pgmq-extension && \ PG_CONFIG=${PGRX_PG_CONFIG} make clean && \ PG_CONFIG=${PGRX_PG_CONFIG} make && \ diff --git a/README.md b/README.md index b01a2ff..e73cd8c 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,9 @@ Execute SQL now and get the results later. -A postgres extension to execute queries asynchronously. Built on [pgmq](https://github.com/tembo-io/pgmq). +A postgres extension to execute queries asynchronously. Built on [pgmq](https://github.com/pgmq/pgmq). -[![Tembo Cloud Try Free](https://tembo.io/tryFreeButton.svg)](https://cloud.tembo.io/sign-up) - -[![Static Badge](https://img.shields.io/badge/%40tembo-community?logo=slack&label=slack)](https://join.slack.com/t/tembocommunity/shared_invite/zt-20dtnhcmo-pLNV7_Aobi50TdTLpfQ~EQ) +[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-13%20%7C%2014%20%7C%2015%20%7C%2016%20%7C%2017%20%7C%2018-336791?logo=postgresql&logoColor=white)](https://www.postgresql.org/) [![PGXN version](https://badge.fury.io/pg/pg_later.svg)](https://pgxn.org/dist/pg_later/) ## Installation @@ -14,10 +12,10 @@ A postgres extension to execute queries asynchronously. Built on [pgmq](https:// ### Run with docker ```bash -docker run -p 5432:5432 -e POSTGRES_PASSWORD=postgres quay.io/tembo/pglater-pg:latest +docker run -p 5432:5432 -e POSTGRES_PASSWORD=postgres ghcr.io/chuckhend/pglater-pg:latest ``` -If you'd like to build from source, you can follow the instructions in [CONTRIBUTING.md](https://github.com/tembo-io/pg_later/blob/main/CONTRIBUTING.md). +If you'd like to build from source, you can follow the instructions in [CONTRIBUTING.md](https://github.com/chuckhend/pg_later/blob/main/CONTRIBUTING.md). ### Using the extension diff --git a/Trunk.toml b/Trunk.toml deleted file mode 100644 index 4d545b8..0000000 --- a/Trunk.toml +++ /dev/null @@ -1,14 +0,0 @@ -[extension] -name = "pg_later" -repository = "https://github.com/tembo-io/pg_later" -license = "PostgreSQL" -description = "Execute SQL statements now and check the results later." -homepage = "https://github.com/tembo-io/pg_later" -documentation = "https://github.com/tembo-io/pg_later" -categories = ["orchestration"] -version = "0.3.0" -loadable_libraries = [{ library_name = "pg_later", requires_restart = true }] - -[build] -postgres_version = "15" -platform = "linux/amd64"