Skip to content

Commit

Permalink
Prepare 2.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
05nelsonm committed Jun 21, 2023
1 parent 2b6c570 commit 238939d
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 14 deletions.
28 changes: 27 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# CHANGELOG

## Version 2.0.0 (2023-06-21)
- Fixes JPMS split package exception [[#126]][126] & [[#127]][127]
- **API BREAKING CHANGES**
- See the [MIGRATION][MIGRATION] guide for more details
- Updates the `Maven Central` group & artifact ids
- **NEW:**
- `io.matthewnelson.encoding:bom:2.0.0`
- `io.matthewnelson.encoding:core:2.0.0`
- `io.matthewnelson.encoding:base16:2.0.0`
- `io.matthewnelson.encoding:base32:2.0.0`
- `io.matthewnelson.encoding:base64:2.0.0`
- **OLD:**
- `io.matthewnelson.kotlin-components:encoding-bom:1.2.3`
- `io.matthewnelson.kotlin-components:encoding-core:1.2.3`
- `io.matthewnelson.kotlin-components:encoding-base16:1.2.3`
- `io.matthewnelson.kotlin-components:encoding-base32:1.2.3`
- `io.matthewnelson.kotlin-components:encoding-base64:1.2.3`
- Promotes `EncoderDecoder.Feed`s to stable by removing the
`ExperimentalEncodingApi` annotation [[#130]][130]
- In the event of a decoding failure, the underlying `ByteArray` is now
cleared prior to throwing the exception [[#132]][132]

## Version 1.2.3 (2023-06-21)
- Deprecates `...encoding.builders` package path classes/functions for
`encoding-base16`, `encoding-base32`, `encoding-base64` modules
Expand All @@ -9,7 +31,7 @@
- `...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.
- 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.

Expand Down Expand Up @@ -131,4 +153,8 @@
[118]: https://github.com/05nelsonm/encoding/pull/118
[122]: https://github.com/05nelsonm/encoding/pull/122
[124]: https://github.com/05nelsonm/encoding/issues/124
[126]: https://github.com/05nelsonm/encoding/pull/126
[127]: https://github.com/05nelsonm/encoding/pull/127
[130]: https://github.com/05nelsonm/encoding/pull/130
[132]: https://github.com/05nelsonm/encoding/pull/132
[MIGRATION]: https://github.com/05nelsonm/encoding/blob/master/MIGRATION.md
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,13 +273,13 @@ See [sample project](sample/README.md)
```kotlin
// build.gradle.kts
dependencies {
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")
val encoding = "2.0.0"
implementation("io.matthewnelson.encoding:base16:$encoding")
implementation("io.matthewnelson.encoding:base32:$encoding")
implementation("io.matthewnelson.encoding:base64:$encoding")

// Only necessary if you just want the abstractions to create your own EncoderDecoder(s)
implementation("io.matthewnelson.kotlin-components:encoding-core:$encoding")
implementation("io.matthewnelson.encoding:core:$encoding")
}
```

Expand All @@ -290,20 +290,20 @@ 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.3"))
implementation(platform("io.matthewnelson.encoding:bom:2.0.0"))

// define artifacts without version
implementation("io.matthewnelson.kotlin-components:encoding-base16")
implementation("io.matthewnelson.kotlin-components:encoding-base32")
implementation("io.matthewnelson.kotlin-components:encoding-base64")
implementation("io.matthewnelson.encoding:base16")
implementation("io.matthewnelson.encoding:base32")
implementation("io.matthewnelson.encoding:base64")

// Only necessary if you just want the abstractions to create your own EncoderDecoder(s)
implementation("io.matthewnelson.kotlin-components:encoding-core")
implementation("io.matthewnelson.encoding:core")
}
```

<!-- TAG_VERSION -->
[badge-latest-release]: https://img.shields.io/badge/latest--release-1.2.3-blue.svg?style=flat
[badge-latest-release]: https://img.shields.io/badge/latest--release-2.0.0-blue.svg?style=flat
[badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat

<!-- TAG_DEPENDENCIES -->
Expand Down
2 changes: 1 addition & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ git branch -D release_"$VERSION_NAME"
### Linux
- Wait for releases to become available on [MavenCentral](https://repo1.maven.org/maven2/io/matthewnelson/kotlin-components/)
- Wait for releases to become available on [MavenCentral](https://repo1.maven.org/maven2/io/matthewnelson/encoding/)
- Draft new release on GitHub
- Enter the release name <VersionName> as tag and title
- Have the description point to the changelog
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ POM_DEVELOPER_ID=05nelsonm
POM_DEVELOPER_NAME=Matthew Nelson
POM_DEVELOPER_URL=https://github.com/05nelsonm/

VERSION_NAME=2.0.0-SNAPSHOT
VERSION_NAME=2.0.0
# 0.1.0-alpha01 = 00 01 00 11
# 0.1.0-beta01 = 00 01 00 21
# 0.1.0-rc01 = 00 01 00 31
Expand Down

0 comments on commit 238939d

Please sign in to comment.