Better ci and docs#2
Merged
Merged
Conversation
Add [profile.release] to the workspace root: strip="symbols", lto="fat", codegen-units=1. Shrinks the PHP extension from 3.68 MB to 2.36 MB (-36%). Deliberately keeps panic="unwind" (the default): the sdsearch-php FFI boundary relies on catch_unwind to turn a Rust panic into a catchable PhpException and keep the PHP worker alive; panic="abort" would break that. Documented as an invariant in the manifest.
on.push had no branch filter, so every job ran on both push and pull_request: a push to a branch with an open PR built the whole pipeline twice. Restrict push to main and v* tags (feature branches are covered by their pull_request run) and add a concurrency group that cancels superseded in-flight runs.
Byte-by-byte layout of every ZSL index file (.cfs, .fnm, .fdt/.fdx, .tis/.tii, .frq/.prx, .nrm, .del, segments.gen/segments_N) with ASCII field diagrams, the modified-UTF-8 / SmallFloat / VInt quirks, and worked hex examples. Derived from the parsers in sdsearch-core/src/zsl. Linked from ARCHITECTURE.md and the README.
Add sdsearch.stub.php: signatures + PHPDoc for the whole extension surface (sdsearch_version, SdSearch\Engine, SdSearch\Writer) for IDEs/PHPStan; never loaded at runtime. Add docs/API.md: narrative guide with end-to-end indexing/update/search examples, the params + hit JSON contracts, and the field kinds. Symbol names verified by Reflection against the compiled extension; stub passes 'php -n -l'. Linked from README.
On a v* tag, build + smoke-test three PHP 8.4 NTS binaries in parallel and publish them to a GitHub Release: - sdsearch-windows-x64-php84nts.dll (windows-latest, nightly + LLVM) - sdsearch-ubuntu-x64-php84nts.so (ubuntu-latest, glibc ~2.39) - sdsearch-el8-x64-php84nts.so (rockylinux:8 container, glibc 2.28) The EL8 build (Rocky 8 + Remi PHP 8.4 NTS) links only up to GLIBC_2.28, so it loads on RHEL/CentOS/Rocky/Alma 8 & 9 (verified locally in a rockylinux:8 container). ext-php-rs needs PHP/PHP_CONFIG set explicitly in the container. The publish job asserts the tag equals sdsearch-core's crate version, then attaches the binaries. workflow_dispatch runs a build-only dry run (no release). github.ref_name is passed via env and quoted.
Contributor
Code Metrics Report
Details | | main (92a895e) | #2 (a6f4607) | +/- |
|---------------------|----------------|--------------|------|
| Coverage | 96.4% | 96.4% | 0.0% |
| Files | 36 | 36 | 0 |
| Lines | 4398 | 4398 | 0 |
| Covered | 4244 | 4244 | 0 |
+ | Test Execution Time | 11s | 5s | -6s |Reported by octocov |
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.
No description provided.