Skip to content

Commit

Permalink
release 0.1.0 – Binary Compatibility Validator for Kotlin/JS by Fluxo
Browse files Browse the repository at this point in the history
Fixes Kotlin/binary-compatibility-validator#42
Kotlin/binary-compatibility-validator#42 (comment)

- Based on the generated TS definitions.
- Has support for Kotlin/JS non-KMP projects.
- Compatible with BCV 0.8+

Initially made for the Fluxo state management framework, now published for general use:
https://github.com/fluxo-kt/fluxo

See README for the usage instructions:
https://github.com/fluxo-kt/fluxo-bcv-js#how-to-use

Signed-off-by: Artyom Shendrik <artyom.shendrik@gmail.com>
  • Loading branch information
amal committed May 25, 2023
1 parent 632764e commit d2b2f23
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 3 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,30 @@
- ...


## [0.1.0] - 2023-05-25

🌱 _First stable release._

### Added
- Add Kotlin/JS API support to the KotlinX [Binary Compatibility Validator][bcv] based on the generated TS definitions.
Fixes [Kotlin/binary-compatibility-validator#42](https://github.com/Kotlin/binary-compatibility-validator/issues/42)
- Add support for Kotlin/JS non-KMP projects.
- Add compatibility with [BCV][bcv] 0.8+
- Add line endings normalization for TS definition files.
- Add documentation and usage examples.


## [0.0.1-rc] - 2023-05-25

🌱 _Initial `fluxo-bcv-js` pre-release in the [Gradle Plugin Portal](https://plugins.gradle.org/plugin/io.github.fluxo-kt.binary-compatibility-validator-js)._


## Notes

[0.1.0]: https://github.com/fluxo-kt/fluxo-bcv-js/releases/tag/v0.1.0
[0.0.1-rc]: https://github.com/fluxo-kt/fluxo-bcv-js/releases/tag/v0.0.1-rc

[bcv]: https://github.com/Kotlin/binary-compatibility-validator

[^1]: Uses [Common Changelog style](https://common-changelog.org/) [^2]
[^2]: https://github.com/vweevers/common-changelog#readme
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ haven't been changed in a way that makes this change binary incompatible.

This plugin will be supported until the official Kotlin/JS support is added to [BCV][bcv].

Initially was made for the [Fluxo][fluxo] state management framework,
Initially [was made][fluxo-bcv-commit] for the [Fluxo][fluxo] state management framework,
but then published for general use.


Expand All @@ -52,7 +52,7 @@ Compatibility tested with:
plugins {
kotlin("multiplatform") version "1.8.21" // <-- multiplatform or js, versions from 1.6.20 to 1.9
id("org.jetbrains.kotlinx.binary-compatibility-validator") version "0.12.1" // <-- 0.8 .. 0.13
id("io.github.fluxo-kt.binary-compatibility-validator-js") version "0.0.1-rc" // <-- add here
id("io.github.fluxo-kt.binary-compatibility-validator-js") version "0.1.0" // <-- add here
}
kotlin {
js(IR) {
Expand Down Expand Up @@ -128,3 +128,4 @@ This project is licensed under the Apache License, Version 2.0 — see the
[badge-jitpack]: https://www.jitpack.io/v/fluxo-kt/fluxo-bcv-js.svg

[fluxo]: https://github.com/fluxo-kt/fluxo
[fluxo-bcv-commit]: https://github.com/fluxo-kt/fluxo/commit/252e5d859078ea28e5bf496067424b0b5b5c8f73
2 changes: 1 addition & 1 deletion gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

[versions]

fluxoBcvJs = "0.1.0-dev"
fluxoBcvJs = "0.1.0"

# Public API management tool
# https://github.com/Kotlin/binary-compatibility-validator/releases
Expand Down

0 comments on commit d2b2f23

Please sign in to comment.