Skip to content

Add PGXN distribution metadata - #344

Open
waldemort-auto[bot] wants to merge 1 commit into
mainfrom
waldemort/pgxn-distribution
Open

Add PGXN distribution metadata#344
waldemort-auto[bot] wants to merge 1 commit into
mainfrom
waldemort/pgxn-distribution

Conversation

@waldemort-auto

Copy link
Copy Markdown

Why

pg_durable is absent from every PostgreSQL extension registry. Verified 2026-08-13:

Registry Result
PGXN pgxn.org/dist/pg_durable/ -> HTTP 404
Pigsty pgsty.com/ext/pg_durable/ -> HTTP 404
Trunk (pgt.dev) not verified (unreachable from the checking network)
pgxman not verified (HTTP 402 from the checking network)

The usual framing is that the only install paths are build-from-source, the GHCR image, or a managed service. That is out of date: package-release.yml already builds Debian packages for PG 17 and 18, validates each one inside a real debian:bookworm container against a PGDG PostgreSQL, and publishes them with source tarballs and SHA256SUMS.

So the gap is not that pg_durable is unpackaged. It is that it is packaged but undiscoverable, and not in a shape anyone else can redistribute. PGXN's Meta Spec file is mandatory, and this repository has no META.json, so a listing is currently structurally impossible rather than merely unrequested. This change fixes that.

What changed

File Change
META.json.in New. PGXN Meta Spec 1.0.0 document. version uses the @CARGO_VERSION@ token that pgrx already substitutes into pg_durable.control, so the distribution version is derived from Cargo.toml and cannot drift. META.json itself is generated, never committed.
Makefile Adds DISTNAME/DISTVERSION, a META.json render rule, a pgxn-zip bundle target, EXTRA_CLEAN, one .PHONY entry and one help line.
.gitignore Ignores generated /META.json and /pg_durable-*.zip.
prompts/pg_durable-release.md Step 2 gains a META.json.in check; new Step 6b documents publishing to PGXN.
README.md Packages section notes PGXN carries the source distribution.

No existing Makefile target changes behaviour. all, build, pg-install, pg-clean and installcheck are untouched, and the pg-install/pg-clean naming introduced in 3dd5035 to avoid PGXS collisions is preserved.

Version handling

DISTVERSION is read from Cargo.toml using the same sed expression already used in package-release.yml. There is no second version to bump at release time.

$ make META.json
sed 's/@CARGO_VERSION@/0.2.6/g' META.json.in > META.json

Validation

Run against the real pgxn/pgxn-tools image, which is the tooling PGXN itself publishes:

Validating META.json...
META.json is OK
Bundling pg_durable-0.2.6.zip ...

make pgxn-zip produces a 335-file archive with pg_durable-0.2.6/META.json at the archive root.

Design notes

The metadata shape follows theory/pg-jsonschema-boon, a pgrx extension published on PGXN by PGXN's own author. That settles two questions that have no obvious answer for a pgrx extension:

  • pgrx extensions are welcome on PGXN, even though the SQL is generated at build time.
  • provides.file points at src/lib.rs, not at a generated .sql file.

license uses the postgresql License String, matching LICENSE.txt and Cargo.toml. Note that the GitHub API currently reports this repository's license as NOASSERTION, so registry metadata scrapers see an unrecognised license; worth a separate look.

Honest scope

pg_durable needs shared_preload_libraries, a background worker, and a fixed target database, so it is not a CREATE EXTENSION-and-done extension. Registry presence buys discoverability and credibility here rather than one-command installs, and managed PostgreSQL services still cannot install it until each provider allow-lists it. Worth having, but not a download-count lever.

There is already unprompted third-party appetite: PGLayers packages pg_durable today, pinning v0.2.5 for PG 17 and 18 in its extension.conf.

Prerequisites and follow-ups

  1. PGXN account. Someone must request an account at manager.pgxn.org/account/register and own the pg_durable distribution. The name is currently free.
  2. Release automation. This PR deliberately touches no workflow file. Wiring the bundle-and-upload into package-release.yml is a follow-up; the publishing app is not currently permitted to modify workflows, so that change needs either a maintainer commit or a workflows permission grant. Until then Step 6b documents the manual path.
  3. make install is broken for source consumers — PGXS installs pg_durable.control with a literal, unsubstituted @CARGO_VERSION@ and no .so. Harmless today because nobody installs that way, but pgxn install pg_durable would walk straight into it. Fix tracked separately so this PR stays metadata-only.

Generated with the assistance of GitHub Copilot.

pg_durable is absent from every PostgreSQL extension registry. PGXN requires a
META.json conforming to the PGXN Meta Spec, which this repository does not
have, so a listing is currently impossible rather than merely unrequested.

- META.json.in carries the PGXN Meta Spec 1.0.0 document and uses the same
  @CARGO_VERSION@ token that pgrx already substitutes into pg_durable.control,
  so the distribution version is derived from Cargo.toml and cannot drift.
  META.json itself is generated, not committed.
- Makefile gains a META.json render rule and a pgxn-zip bundle target, plus
  EXTRA_CLEAN for the generated artifacts. No existing target changes
  behaviour; all, build, pg-install and installcheck are untouched.
- The release runbook gains a PGXN publishing step and the README documents
  the new channel.

Verified with pgxn-bundle from the pgxn/pgxn-tools image: "META.json is OK",
producing pg_durable-0.2.6.zip with META.json at the archive root.

The metadata shape follows theory/pg-jsonschema-boon, the reference pgrx
extension published on PGXN by PGXN's own author, including provides.file
pointing at src/lib.rs.

Publishing is a documented manual step for now. Automating it inside the
Package Release workflow is left to a follow-up so this change touches no
workflow file.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@microsoft-github-policy-service

Copy link
Copy Markdown

@waldemort-auto[bot] please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

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.

0 participants