Skip to content

Commit 238939d

Browse files
committed
Prepare 2.0.0 release
1 parent 2b6c570 commit 238939d

File tree

4 files changed

+40
-14
lines changed

4 files changed

+40
-14
lines changed

CHANGELOG.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# CHANGELOG
22

3+
## Version 2.0.0 (2023-06-21)
4+
- Fixes JPMS split package exception [[#126]][126] & [[#127]][127]
5+
- **API BREAKING CHANGES**
6+
- See the [MIGRATION][MIGRATION] guide for more details
7+
- Updates the `Maven Central` group & artifact ids
8+
- **NEW:**
9+
- `io.matthewnelson.encoding:bom:2.0.0`
10+
- `io.matthewnelson.encoding:core:2.0.0`
11+
- `io.matthewnelson.encoding:base16:2.0.0`
12+
- `io.matthewnelson.encoding:base32:2.0.0`
13+
- `io.matthewnelson.encoding:base64:2.0.0`
14+
- **OLD:**
15+
- `io.matthewnelson.kotlin-components:encoding-bom:1.2.3`
16+
- `io.matthewnelson.kotlin-components:encoding-core:1.2.3`
17+
- `io.matthewnelson.kotlin-components:encoding-base16:1.2.3`
18+
- `io.matthewnelson.kotlin-components:encoding-base32:1.2.3`
19+
- `io.matthewnelson.kotlin-components:encoding-base64:1.2.3`
20+
- Promotes `EncoderDecoder.Feed`s to stable by removing the
21+
`ExperimentalEncodingApi` annotation [[#130]][130]
22+
- In the event of a decoding failure, the underlying `ByteArray` is now
23+
cleared prior to throwing the exception [[#132]][132]
24+
325
## Version 1.2.3 (2023-06-21)
426
- Deprecates `...encoding.builders` package path classes/functions for
527
`encoding-base16`, `encoding-base32`, `encoding-base64` modules
@@ -9,7 +31,7 @@
931
- `...encoding.base64.Builders.kt`
1032
- This is attributed to issue [[#124]][124] whereby JPMS does not allowing
1133
split packages.
12-
- A follow up release of `2.0.0` with the API breaking changes will be had.
34+
- A follow-up release of `2.0.0` with the API breaking changes will be had.
1335
This release is primarily for consumers to migrate as gracefully as possible.
1436
- See the [MIGRATION][MIGRATION] guide for more details.
1537

@@ -131,4 +153,8 @@
131153
[118]: https://github.com/05nelsonm/encoding/pull/118
132154
[122]: https://github.com/05nelsonm/encoding/pull/122
133155
[124]: https://github.com/05nelsonm/encoding/issues/124
156+
[126]: https://github.com/05nelsonm/encoding/pull/126
157+
[127]: https://github.com/05nelsonm/encoding/pull/127
158+
[130]: https://github.com/05nelsonm/encoding/pull/130
159+
[132]: https://github.com/05nelsonm/encoding/pull/132
134160
[MIGRATION]: https://github.com/05nelsonm/encoding/blob/master/MIGRATION.md

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -273,13 +273,13 @@ See [sample project](sample/README.md)
273273
```kotlin
274274
// build.gradle.kts
275275
dependencies {
276-
val encoding = "1.2.3"
277-
implementation("io.matthewnelson.kotlin-components:encoding-base16:$encoding")
278-
implementation("io.matthewnelson.kotlin-components:encoding-base32:$encoding")
279-
implementation("io.matthewnelson.kotlin-components:encoding-base64:$encoding")
276+
val encoding = "2.0.0"
277+
implementation("io.matthewnelson.encoding:base16:$encoding")
278+
implementation("io.matthewnelson.encoding:base32:$encoding")
279+
implementation("io.matthewnelson.encoding:base64:$encoding")
280280

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

@@ -290,20 +290,20 @@ Alternatively, you can use the BOM.
290290
// build.gradle.kts
291291
dependencies {
292292
// define the BOM and its version
293-
implementation(platform("io.matthewnelson.kotlin-components:encoding-bom:1.2.3"))
293+
implementation(platform("io.matthewnelson.encoding:bom:2.0.0"))
294294

295295
// define artifacts without version
296-
implementation("io.matthewnelson.kotlin-components:encoding-base16")
297-
implementation("io.matthewnelson.kotlin-components:encoding-base32")
298-
implementation("io.matthewnelson.kotlin-components:encoding-base64")
296+
implementation("io.matthewnelson.encoding:base16")
297+
implementation("io.matthewnelson.encoding:base32")
298+
implementation("io.matthewnelson.encoding:base64")
299299

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

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

309309
<!-- TAG_DEPENDENCIES -->

RELEASING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ git branch -D release_"$VERSION_NAME"
237237
238238
### Linux
239239
240-
- Wait for releases to become available on [MavenCentral](https://repo1.maven.org/maven2/io/matthewnelson/kotlin-components/)
240+
- Wait for releases to become available on [MavenCentral](https://repo1.maven.org/maven2/io/matthewnelson/encoding/)
241241
- Draft new release on GitHub
242242
- Enter the release name <VersionName> as tag and title
243243
- Have the description point to the changelog

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ POM_DEVELOPER_ID=05nelsonm
2929
POM_DEVELOPER_NAME=Matthew Nelson
3030
POM_DEVELOPER_URL=https://github.com/05nelsonm/
3131

32-
VERSION_NAME=2.0.0-SNAPSHOT
32+
VERSION_NAME=2.0.0
3333
# 0.1.0-alpha01 = 00 01 00 11
3434
# 0.1.0-beta01 = 00 01 00 21
3535
# 0.1.0-rc01 = 00 01 00 31

0 commit comments

Comments
 (0)