Skip to content

Conversation

@oschwald
Copy link
Member

@oschwald oschwald commented Jan 9, 2026

Summary

  • Adds a GitHub Actions workflow (api-compat.yml) that runs on PRs to detect breaking changes in the public API
  • Uses japicmp with semantic versioning support - only fails if breaking changes are detected without a major version bump
  • Configured to check only public API (accessModifier=public)

Test plan

  • Verify the new workflow runs on this PR
  • Create a test branch with a breaking change (remove a public method) and verify it fails
  • Create a test branch with a non-breaking change and verify it passes

ENG-3367

🤖 Generated with Claude Code

@oschwald oschwald force-pushed the greg/eng-3367 branch 5 times, most recently from 312b9f4 to 18f9152 Compare January 12, 2026 18:23
This adds a GitHub Actions workflow that runs on PRs to detect breaking
changes in the public API. The check uses japicmp with semantic versioning
support, so it will only fail if breaking changes are detected without a
major version bump.

ENG-3367

Co-Authored-By: Claude Opus 4.5 <[email protected]>
perl -pi -e "s/(?<=<version>)[^<]*/$version/" README.md
perl -pi -e "s/(?<=com\.maxmind\.geoip2\:geoip2\:)\d+\.\d+\.\d+([\w\-]+)?/$version/" README.md

# Update japicmp.baselineVersion for API compatibility checking
Copy link
Member Author

Choose a reason for hiding this comment

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

Although japicmp has functionality to compare the current version to the previous version, this does not work if we have not yet bumped the version number for a release.

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.

2 participants