Skip to content

STF-2455: Release 1.15.0 - #326

Merged
ugexe merged 5 commits into
mainfrom
greg/release-1.15.0
Nov 18, 2026
Merged

ugexe merged 5 commits into
mainfrom
greg/release-1.15.0

Conversation

@oschwald

@oschwald oschwald commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Release 1.15.0. It is a minor release: it adds UnsupportedPlatformException and makes the pure PHP reader reject more invalid databases.

This PR has four commits:

  • Mark the reader classes @final. They become final in the next major version (ENG-5819). The tag does not change runtime behavior, and PHPUnit can still mock the classes. testReaderIsNotFinal still passes.
  • Update the bundled libmaxminddb to 1.14.1, the latest release. 1.14.1 fixes a -Wsign-compare build failure with -Werror on platforms where ssize_t is 32 bits.
  • Escape the PECL notes without HTML::Entities. The release script used the module only to escape <, > and & in package.xml. I checked the new substitutions on a copy of package.xml with notes that contain &, <, >, $reader and @args. The result parses as XML and round-trips to the original text.
  • Set the release date.

dev-bin/release.sh adds the version updates. It then updates the submodule in MaxMind-DB-Reader-php-ext, and that repository's workflow builds the PIE binaries.

Part of STF-2455.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Updates
    • Updated the bundled MaxMind DB library to version 1.14.1.
    • Updated the package version and installation guidance to 1.15.0.
  • Documentation
    • Clarified that pure PHP reader exception behavior may differ from the C extension.
    • Marked pure PHP reader classes as final in documentation for static analysis. These classes are planned to become final in the next major version.

They become final in the next major version. ENG-5819.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 17, 2026 21:28

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The 1.15.0 release updates package metadata and documentation, adds @final annotations to pure PHP reader classes, updates the bundled libmaxminddb version to 1.14.1, and changes how the release script escapes package notes.

Changes: Reader release changes

Layer / File(s) Summary
Release version and package metadata
package.xml, ext/php_maxminddb.h, README.md, composer.json, CHANGELOG.md
Release metadata and package constraints are updated for version 1.15.0. The release notes describe pure PHP reader exceptions, extension version reporting, bundled library updates, class annotations, and 64-bit Windows integer results.
Reader annotations and bundled library
src/MaxMind/Db/Reader.php, src/MaxMind/Db/Reader/Decoder.php, src/MaxMind/Db/Reader/InvalidDatabaseException.php, src/MaxMind/Db/Reader/Metadata.php, src/MaxMind/Db/Reader/UnsupportedPlatformException.php, src/MaxMind/Db/Reader/Util.php, ext/bundled-include/maxminddb_config.h, ext/libmaxminddb
Six reader class docblocks gain @final annotations. Reader documentation clarifies that its exception declarations describe the pure PHP reader and may differ from the C extension. The bundled libmaxminddb version changes to 1.14.1.
Package-note generation
dev-bin/release.sh
The release script removes its HTML::Entities preflight check and escapes &, <, and > directly in package notes.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: horgh, remicollet

Merge Risk: Minimal · up to 13591

This release mostly updates version numbers, notes, and docblock annotations. Runtime behavior is unchanged, and no merge-blocking risk is evident.

Pre-merge checks: Passed 4

Check name Status Explanation
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "STF-2455: Release 1.15.0" names a release bump to 1.15.0, which matches the main change. The changeset sets version 1.15.0 in package.xml, ext/php_maxminddb.h, and the changelog, and the ob…
Full details: Title check

Explanation

The title "STF-2455: Release 1.15.0" names a release bump to 1.15.0, which matches the main change. The changeset sets version 1.15.0 in package.xml, ext/php_maxminddb.h, and the changelog, and the objectives describe it as a 1.15.0 release. The title does not mention the other changes (bundled libmaxminddb 1.14.1, @final annotations, release script change), but it does not need to cover every detail. The ticket prefix STF-2455 differs from the ENG-5717 ticket in the objectives, which is a minor inconsistency and does not make the title unrelated.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

A rabbit reads the release note bright,
Then checks each version line is right.
“Final” marks the classes in a row,
While bundled library numbers grow.
The notes escape, and off I go!

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 24a9fd87-2622-4c47-8fd6-1dd85dac655f
Commits

Reviewing files that changed from the base of the PR and between 6517913 and 135915a.

Files selected for processing: 4

  • README.md
  • composer.json
  • ext/php_maxminddb.h
  • package.xml

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

oschwald and others added 3 commits November 17, 2026 21:30
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The release script used HTML::Entities only to escape <, > and & in
package.xml. Plain substitutions do the same, so releasing no longer
needs the Perl HTML::Parser distribution.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@oschwald
oschwald force-pushed the greg/release-1.15.0 branch from 9a658d5 to 6517913 Compare November 17, 2026 21:30
Copilot AI balanced review requested due to automatic review settings November 17, 2026 21:30

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@oschwald oschwald changed the title Release 1.15.0 ENG-5717: Release 1.15.0 Nov 17, 2026
Copilot AI balanced review requested due to automatic review settings November 17, 2026 21:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@oschwald oschwald changed the title ENG-5717: Release 1.15.0 STF-2455: Release 1.15.0 Nov 17, 2026
@ugexe
ugexe merged commit 6f775e8 into main Nov 18, 2026
197 checks passed
@ugexe
ugexe deleted the greg/release-1.15.0 branch November 18, 2026 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants