Fix stale README/CLAUDE.md docs; rename internal-only test shim - #76
Merged
jnasbyupgrade merged 1 commit intoJul 29, 2026
Merged
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
jnasbyupgrade
changed the title
Found by the /release skill's API documentation review ahead of 2.2.0: - Rename `PGXNTOOL_CHECK_STALE_EXPECTED_SCRIPT` to `_CHECK_STALE_EXPECTED_SCRIPT`, establishing a leading-underscore convention for internal-only override points (test-stubbing seams, not user-facing config) that don't belong under the `PGXNTOOL_` prefix. - Document `PGTLE_VERSION` in README.asc (pgtle section + Configuration Variables) -- it was fixed and used in HISTORY.asc/CLAUDE.md but never actually documented for users. - Fix the versioned-SQL-file code example in README.asc, which still showed the truncate+append pattern that was fixed for parallel-build corruption. - Update stale `decibel/pgxntool` URLs (Install command, issue links, license links) to `Postgres-Extensions/pgxntool`, and fix `LICENCE`/ `JSON.sh.LICENCE` typos to `LICENSE`/`JSON.sh.LICENSE`. - Document `update-setup-files.sh` as directly invokable in the pgxntool-sync section. - Fix CLAUDE.md: nonexistent `install-pgtle` target -> `run-pgtle`, wrong `check-pgtle`/`run-pgtle` descriptions, wrong script name `pgtle-wrap.sh` -> `pgtle.sh`, and `make tag` creates a tag, not a branch. - Regenerate README.html from README.asc. Related changes in pgxntool-test: - Update `_CHECK_STALE_EXPECTED_SCRIPT` references in `make-test.bats`/`helpers.bash` - Document the underscore-prefix internal-only convention in the API surface definition Co-Authored-By: Claude <noreply@anthropic.com>
jnasbyupgrade
force-pushed
the
doc-drift-fixes
branch
from
July 29, 2026 20:52
890f904 to
9e3dcbb
Compare
jnasbyupgrade
added a commit
that referenced
this pull request
Jul 29, 2026
Related changes in pgxntool-test: Postgres-Extensions/pgxntool-test#52 - Update `_CHECK_STALE_EXPECTED_SCRIPT` references in `test/standard/make-test.bats`/`test/lib/helpers.bash` to match the rename - Document the new leading-underscore internal-only-variable convention in the API surface definition Co-Authored-By: Claude <noreply@anthropic.com>
jnasbyupgrade
added a commit
to Postgres-Extensions/pgxntool-test
that referenced
this pull request
Jul 29, 2026
…ble (#52) Companion to Postgres-Extensions/pgxntool#76 (merged as commit d949d6d), found by the `/release` skill's API documentation review ahead of 2.2.0.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Found by the
/releaseskill's API documentation review ahead of 2.2.0.PGXNTOOL_CHECK_STALE_EXPECTED_SCRIPTto_CHECK_STALE_EXPECTED_SCRIPT, establishing a leading-underscore convention for internal-only override points (test-stubbing seams, not user-facing config) that don't belong under thePGXNTOOL_prefix.PGTLE_VERSIONin README.asc (pgtle section + Configuration Variables) -- it was fixed and used in HISTORY.asc/CLAUDE.md but never actually documented for users.decibel/pgxntoolURLs (Install command, issue links, license links) toPostgres-Extensions/pgxntool, and fixLICENCE/JSON.sh.LICENCEtypos toLICENSE/JSON.sh.LICENSE.update-setup-files.shas directly invokable in the pgxntool-sync section.install-pgtletarget ->run-pgtle, wrongcheck-pgtle/run-pgtledescriptions, wrong script namepgtle-wrap.sh->pgtle.sh, andmake tagcreates a tag, not a branch.Companion PR: Postgres-Extensions/pgxntool-test#52 (renamed variable references + API-surface convention doc).
Not included per explicit decision: the
EXTRA_CLEAN/make cleanfix from a prior commit stays undocumented in HISTORY.asc (too minor to mention);EXTENSION__CURRENT_VERSION__FILESis left as-is (not meant to be overridden, just referenced).