diff --git a/CHANGELOG.md b/CHANGELOG.md index 1503420..aae276d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # CHANGELOG +## Version 1.2.3 (2023-06-21) + - Deprecates `...encoding.builders` package path classes/functions for + `encoding-base16`, `encoding-base32`, `encoding-base64` modules + and re-introduces them at new package locations + - `...encoding.base16.Builders.kt` + - `...encoding.base32.Builders.kt` + - `...encoding.base64.Builders.kt` + - This is attributed to issue [[#124]][124] whereby JPMS does not allowing + split packages. + - A follow up release of `2.0.0` with the API breaking changes will be had. + This release is primarily for consumers to migrate as gracefully as possible. + - See the [MIGRATION][MIGRATION] guide for more details. + ## Version 1.2.2 (2023-06-03) - Build improvements [[#106]][106] - Removes `kotln-components` submodule @@ -117,3 +130,5 @@ [114]: https://github.com/05nelsonm/encoding/pull/114 [118]: https://github.com/05nelsonm/encoding/pull/118 [122]: https://github.com/05nelsonm/encoding/pull/122 +[124]: https://github.com/05nelsonm/encoding/issues/124 +[MIGRATION]: https://github.com/05nelsonm/encoding/blob/master/MIGRATION.md diff --git a/MIGRATION.md b/MIGRATION.md index 615c748..8c53552 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -14,7 +14,7 @@ For more details, see [[#124]][124]. ## Migration guide for 1.x.x -> 2.0.0 - - Update dependency to `1.2.3` + - Update dependency to version `1.2.3` - Migration method 1: - Use your IDE or editor to search your project for the following ``` @@ -24,6 +24,18 @@ For more details, see [[#124]][124]. - Migration method 2: - Use the provided `ReplaceWith` functionality of the `@Deprecated` notice to update to the new builder class/function package locations. - - Update dependency to `2.0.0` + - Update dependencies to new maven target: + ```kotlin + // Bill of Materials + implementation(platform("io.matthewnelson.encoding:bom:2.0.0")) -[124]: https://github.com/05nelsonm/encoding/issues/124 \ No newline at end of file + // New Maven Central target (include version if not using the BOM) + implementation("io.matthewnelson.encoding:base16") + implementation("io.matthewnelson.encoding:base32") + implementation("io.matthewnelson.encoding:base64") + + // optionally if you only want the abstractions + implementation("io.matthewnelson.encoding:core") + ``` + +[124]: https://github.com/05nelsonm/encoding/issues/124 diff --git a/README.md b/README.md index 4cb7420..d1e7643 100644 --- a/README.md +++ b/README.md @@ -279,7 +279,7 @@ See [sample project](sample/README.md) ```kotlin // build.gradle.kts dependencies { - val encoding = "1.2.2" + val encoding = "1.2.3" implementation("io.matthewnelson.kotlin-components:encoding-base16:$encoding") implementation("io.matthewnelson.kotlin-components:encoding-base32:$encoding") implementation("io.matthewnelson.kotlin-components:encoding-base64:$encoding") @@ -296,7 +296,7 @@ Alternatively, you can use the BOM. // build.gradle.kts dependencies { // define the BOM and its version - implementation(platform("io.matthewnelson.kotlin-components:encoding-bom:1.2.2")) + implementation(platform("io.matthewnelson.kotlin-components:encoding-bom:1.2.3")) // define artifacts without version implementation("io.matthewnelson.kotlin-components:encoding-base16") @@ -309,7 +309,7 @@ dependencies { ``` -[badge-latest-release]: https://img.shields.io/badge/latest--release-1.2.2-blue.svg?style=flat +[badge-latest-release]: https://img.shields.io/badge/latest--release-1.2.3-blue.svg?style=flat [badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat diff --git a/RELEASING.md b/RELEASING.md index 8d0cf9d..6daa88a 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -23,8 +23,6 @@ git checkout -b release_"$VERSION_NAME" - Update `version` in project's `README.md` documentation -- Update the Kotlin Version compatibility matrix in project's `README.md` documentation - - Update `CHANGELOG.md` - Commit Changes diff --git a/gradle.properties b/gradle.properties index 8089cb5..858259a 100644 --- a/gradle.properties +++ b/gradle.properties @@ -29,7 +29,7 @@ POM_DEVELOPER_ID=05nelsonm POM_DEVELOPER_NAME=Matthew Nelson POM_DEVELOPER_URL=https://github.com/05nelsonm/ -VERSION_NAME=1.2.3-SNAPSHOT +VERSION_NAME=1.2.3 # 0.1.0-alpha01 = 00 01 00 11 # 0.1.0-beta01 = 00 01 00 21 # 0.1.0-rc01 = 00 01 00 31