Kotlin/binary-compatibility-validator (org.jetbrains.kotlinx:binary-compatibility-validator)
### [`v0.15.0-Beta.3`](https://togithub.com/Kotlin/binary-compatibility-validator/releases/tag/0.15.0-Beta.3)
[Compare Source](https://togithub.com/Kotlin/binary-compatibility-validator/compare/0.15.0-Beta.2...0.15.0-Beta.3)
This release provides updated KLib validation support and fixes some previously reported KLib-related issues.
**The release contains some breaking changes** that were made to align and fix BCV behavior across all supported configurations:
- BCV now (again) uses case-sensitive dump file names ([#237](https://togithub.com/Kotlin/binary-compatibility-validator/issues/237));
- Multiplatform projects having no release sources (for instance, test-only projects) now need to be either explicitly excluded or an empty dump file needs to be generated for them ([#231](https://togithub.com/Kotlin/binary-compatibility-validator/issues/231));
- Gradle tasks provided by the plugin changed their API to use Gradle `Properties` instead of plain Kotlin properties.
If any of these changes affect your projects, **please check the migration guide** for details on what needs to be done to update BCV to `0.15.0-Beta.3`: [0.15.0 Migration Guide](https://togithub.com/Kotlin/binary-compatibility-validator/blob/master/docs/design/0.15.0-migration-guide.md).
Compared to `0.15.0-Beta.2`, the KLib ABI dump file format was changed to be more readable ([#196](https://togithub.com/Kotlin/binary-compatibility-validator/issues/196), [#197](https://togithub.com/Kotlin/binary-compatibility-validator/issues/197)). The newer BCV version will successfully validate the ABI against golden dump files generated by previous versions, but the execution of the `apiDump` task will result in updated `.klib.api` files even if the ABI itself remains the same. Thus, it's recommended to update the plugin and dump files separately from changes affecting your code.
**What changed:**
- KLib validation-related Gradle tasks were made public ([#203](https://togithub.com/Kotlin/binary-compatibility-validator/issues/203), [#204](https://togithub.com/Kotlin/binary-compatibility-validator/issues/204))
- KLib ABI dump format was improved to group declarations by their type ([#197](https://togithub.com/Kotlin/binary-compatibility-validator/issues/197), [#224](https://togithub.com/Kotlin/binary-compatibility-validator/issues/224)), and additional vertical spacing was added to improve reliability ([#196](https://togithub.com/Kotlin/binary-compatibility-validator/issues/196), [#225](https://togithub.com/Kotlin/binary-compatibility-validator/issues/225))
- API dump file names (for both JVM and Klib dumps) need to be case-sensitive ([#231](https://togithub.com/Kotlin/binary-compatibility-validator/issues/231), [#237](https://togithub.com/Kotlin/binary-compatibility-validator/issues/237))
- Validation behavior for empty projects was aligned across all supported configurations ([#243](https://togithub.com/Kotlin/binary-compatibility-validator/issues/243), [#244](https://togithub.com/Kotlin/binary-compatibility-validator/issues/244)); now, such projects must either contain API dump files or be explicitly excluded using `ignoredProjects.`
- Fixed issue with removed native targets not triggering ABI validation failure ([#234](https://togithub.com/Kotlin/binary-compatibility-validator/issues/234), [#236](https://togithub.com/Kotlin/binary-compatibility-validator/issues/236))
- Improved `KlibSignatureVersion.toString` format ([#219](https://togithub.com/Kotlin/binary-compatibility-validator/issues/219), [#220](https://togithub.com/Kotlin/binary-compatibility-validator/issues/220))
- Made `apiValidation.klib` extension Groovy-friendly ([#214](https://togithub.com/Kotlin/binary-compatibility-validator/issues/214), [#215](https://togithub.com/Kotlin/binary-compatibility-validator/issues/215))
- Few other minor improvements and bug fixes ([#221](https://togithub.com/Kotlin/binary-compatibility-validator/issues/221), [#229](https://togithub.com/Kotlin/binary-compatibility-validator/issues/229), [#238](https://togithub.com/Kotlin/binary-compatibility-validator/issues/238))
Thanks to everyone who tried KLib validation support. Special thanks to [@JakeWharton](https://togithub.com/JakeWharton), [@illarionov](https://togithub.com/illarionov), [@aSemy](https://togithub.com/aSemy), [@sandwwraith](https://togithub.com/sandwwraith) for your feedback and suggestions!
Configuration
š Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
š¦ Automerge: Disabled by config. Please merge this manually once you are satisfied.
ā» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
š Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
0.15.0-Beta.2->0.15.0-Beta.3Release Notes
Kotlin/binary-compatibility-validator (org.jetbrains.kotlinx:binary-compatibility-validator)
### [`v0.15.0-Beta.3`](https://togithub.com/Kotlin/binary-compatibility-validator/releases/tag/0.15.0-Beta.3) [Compare Source](https://togithub.com/Kotlin/binary-compatibility-validator/compare/0.15.0-Beta.2...0.15.0-Beta.3) This release provides updated KLib validation support and fixes some previously reported KLib-related issues. **The release contains some breaking changes** that were made to align and fix BCV behavior across all supported configurations: - BCV now (again) uses case-sensitive dump file names ([#237](https://togithub.com/Kotlin/binary-compatibility-validator/issues/237)); - Multiplatform projects having no release sources (for instance, test-only projects) now need to be either explicitly excluded or an empty dump file needs to be generated for them ([#231](https://togithub.com/Kotlin/binary-compatibility-validator/issues/231)); - Gradle tasks provided by the plugin changed their API to use Gradle `Properties` instead of plain Kotlin properties. If any of these changes affect your projects, **please check the migration guide** for details on what needs to be done to update BCV to `0.15.0-Beta.3`: [0.15.0 Migration Guide](https://togithub.com/Kotlin/binary-compatibility-validator/blob/master/docs/design/0.15.0-migration-guide.md). Compared to `0.15.0-Beta.2`, the KLib ABI dump file format was changed to be more readable ([#196](https://togithub.com/Kotlin/binary-compatibility-validator/issues/196), [#197](https://togithub.com/Kotlin/binary-compatibility-validator/issues/197)). The newer BCV version will successfully validate the ABI against golden dump files generated by previous versions, but the execution of the `apiDump` task will result in updated `.klib.api` files even if the ABI itself remains the same. Thus, it's recommended to update the plugin and dump files separately from changes affecting your code. **What changed:** - KLib validation-related Gradle tasks were made public ([#203](https://togithub.com/Kotlin/binary-compatibility-validator/issues/203), [#204](https://togithub.com/Kotlin/binary-compatibility-validator/issues/204)) - KLib ABI dump format was improved to group declarations by their type ([#197](https://togithub.com/Kotlin/binary-compatibility-validator/issues/197), [#224](https://togithub.com/Kotlin/binary-compatibility-validator/issues/224)), and additional vertical spacing was added to improve reliability ([#196](https://togithub.com/Kotlin/binary-compatibility-validator/issues/196), [#225](https://togithub.com/Kotlin/binary-compatibility-validator/issues/225)) - API dump file names (for both JVM and Klib dumps) need to be case-sensitive ([#231](https://togithub.com/Kotlin/binary-compatibility-validator/issues/231), [#237](https://togithub.com/Kotlin/binary-compatibility-validator/issues/237)) - Validation behavior for empty projects was aligned across all supported configurations ([#243](https://togithub.com/Kotlin/binary-compatibility-validator/issues/243), [#244](https://togithub.com/Kotlin/binary-compatibility-validator/issues/244)); now, such projects must either contain API dump files or be explicitly excluded using `ignoredProjects.` - Fixed issue with removed native targets not triggering ABI validation failure ([#234](https://togithub.com/Kotlin/binary-compatibility-validator/issues/234), [#236](https://togithub.com/Kotlin/binary-compatibility-validator/issues/236)) - Improved `KlibSignatureVersion.toString` format ([#219](https://togithub.com/Kotlin/binary-compatibility-validator/issues/219), [#220](https://togithub.com/Kotlin/binary-compatibility-validator/issues/220)) - Made `apiValidation.klib` extension Groovy-friendly ([#214](https://togithub.com/Kotlin/binary-compatibility-validator/issues/214), [#215](https://togithub.com/Kotlin/binary-compatibility-validator/issues/215)) - Few other minor improvements and bug fixes ([#221](https://togithub.com/Kotlin/binary-compatibility-validator/issues/221), [#229](https://togithub.com/Kotlin/binary-compatibility-validator/issues/229), [#238](https://togithub.com/Kotlin/binary-compatibility-validator/issues/238)) Thanks to everyone who tried KLib validation support. Special thanks to [@JakeWharton](https://togithub.com/JakeWharton), [@illarionov](https://togithub.com/illarionov), [@aSemy](https://togithub.com/aSemy), [@sandwwraith](https://togithub.com/sandwwraith) for your feedback and suggestions!Configuration
š Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
š¦ Automerge: Disabled by config. Please merge this manually once you are satisfied.
ā» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
š Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.