Skip to content

Commit 9db1aba

Browse files
committed
Add PGXN section to the readme
1 parent 3ab60d2 commit 9db1aba

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,35 @@ The extension is designed for production use with minimal overhead:
331331

332332
In `normal` mode with a reasonable threshold (e.g., 2.0), only a small fraction of queries are tracked, making the overhead virtually undetectable.
333333

334+
## PGXN Distribution
335+
336+
To prepare and publish a release to [PGXN](https://pgxn.org/):
337+
338+
1. **Update the version** consistently in three files:
339+
- `Makefile` (`EXTVERSION`)
340+
- `META.json` (`version` and `provides``version`, `file`)
341+
- `pg_track_optimizer.control` (`default_version`)
342+
343+
2. **Commit and tag** the release:
344+
```bash
345+
git commit -am "Release X.Y.Z"
346+
git tag vX.Y.Z
347+
```
348+
349+
3. **Build the distribution zip**:
350+
```bash
351+
make dist
352+
```
353+
This runs `git archive` and produces `pg_track_optimizer-X.Y.Z.zip`.
354+
355+
4. **Upload to PGXN**:
356+
```bash
357+
pgxn-utils upload pg_track_optimizer-X.Y.Z.zip
358+
```
359+
Or upload manually at https://manager.pgxn.org/upload.
360+
361+
> **Tip**: Install the PGXN client with `pip install pgxn-utils` or `sudo apt install pgxnclient`.
362+
334363
## Licence
335364

336365
This project is licenced under the MIT Licence. See the LICENCE file for details.

0 commit comments

Comments
 (0)