Skip to content

docs: update install commands; drop skip-locked keyword#230

Merged
NikolayS merged 1 commit intomainfrom
docs/install-commands-rc1
May 7, 2026
Merged

docs: update install commands; drop skip-locked keyword#230
NikolayS merged 1 commit intomainfrom
docs/install-commands-rc1

Conversation

@NikolayS
Copy link
Copy Markdown
Owner

@NikolayS NikolayS commented May 7, 2026

Summary

The three client libraries (pgque-py, pgque, pgque-go) are now published at v0.2.0-rc.1 to PyPI, npm, and the public Go module mirror. The READMEs still said "after the first ... release" — fixed.

Changes

  • `README.md` (top-level): drop "after the first ... release" comments from each install snippet; replace with the actual rc-aware install commands.
  • `clients/python/README.md`: `pip install --pre pgque-py` (or pin `==0.2.0rc1`). `--pre` is needed because pip skips prereleases by default.
  • `clients/typescript/README.md`: `npm install pgque@rc`. The `@rc` dist-tag will keep working through rc.N drops; users can drop the tag once v0.2.0 ships.
  • `clients/go/README.md`: `go get github.com/NikolayS/pgque-go@v0.2.0-rc.1`. `@latest` also works while the v0.2.0 line is in rc.
  • `clients/typescript/package.json`: drop `skip-locked` from keywords. Misleading — pgque uses PgQ's tick-based snapshot visibility, not FOR UPDATE SKIP LOCKED (that's pgmq's mechanism). Replaced with `background-jobs` (already a keyword in pgque-py's metadata for cross-ecosystem consistency).

Validation

End-to-end smoke tests against published packages all pass:

Registry Install command tested Send/Receive/Ack Stale ack rowcount
PyPI `pip install --pre pgque-py==0.2.0rc1` ✅ 0
npm `npm install pgque@rc` (then ESM `import`) ✅ 0
Go module proxy `go get github.com/NikolayS/pgque-go@v0.2.0-rc.1` ✅ 0

The keyword removal only takes effect on the next npm publish (rc.2 / GA); rc.1 retains `skip-locked` on its registry page until then.

Test plan

  • CI green
  • Verify rendered READMEs on the PR's diff view look correct

🤖 Generated with Claude Code

The three client libraries (pgque-py, pgque, pgque-go) are published as
v0.2.0-rc.1 to PyPI, npm, and the public Go module mirror. Update README
install instructions to reflect this:

- pip needs --pre (or pin ==0.2.0rc1) while v0.2.0 is in rc.
- npm install pgque@rc to pin the rc dist-tag.
- go get github.com/NikolayS/pgque-go@v0.2.0-rc.1 (or @latest while only
  the rc tag exists).

Also drop "skip-locked" from clients/typescript/package.json keywords —
PgQue uses PgQ's tick-based snapshot visibility, not FOR UPDATE SKIP
LOCKED (that's pgmq's mechanism). The keyword is misleading. Replaced
with "background-jobs" which already lives in pgque-py's metadata.

Will take effect on rc.2 / GA republish; current rc.1 retains the old
keyword on registry pages until the next publish.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@NikolayS NikolayS merged commit 681e610 into main May 7, 2026
12 checks passed
@NikolayS NikolayS deleted the docs/install-commands-rc1 branch May 7, 2026 20:14
@NikolayS NikolayS mentioned this pull request May 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant