Skip to content

Commit

Permalink
Prepare 0.3.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
05nelsonm committed Jun 28, 2023
1 parent 6c141ef commit 5e1f6e7
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 8 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# CHANGELOG

## Version 0.3.0 (2023-06-28)
- Fixes JPMS split packages [[#48]][48]
- **API BREAKING CHANGES**
- Package names were changed for `digest`, `mac`, and `xof` dependencies
- Example:
- `org.kotlincrypto.core.Digest` was moved to `org.kotlincrypto.core.digest.Digest`
- `org.kotlincrypto.core.Mac` was moved to `org.kotlincrypto.core.mac.Mac`
- `org.kotlincrypto.core.Xof` was moved to `org.kotlincrypto.core.xof.Xof`

## Version 0.2.7 (2023-06-09)
- Fixes Android API 23 and below not calling `javax.crypto.MacSpi.engineReset`
whenever `javax.crypto.Mac.doFinal` is invoked [[#46]][46]
Expand Down Expand Up @@ -74,3 +83,4 @@
[43]: https://github.com/KotlinCrypto/core/pull/43
[44]: https://github.com/KotlinCrypto/core/pull/44
[46]: https://github.com/KotlinCrypto/core/pull/46
[48]: https://github.com/KotlinCrypto/core/pull/48
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ fun main() {
```kotlin
// Using SecureRandom from the secure-random repo as an example
import org.kotlincrypto.SecureRandom
// Using HmacSHA256 from the MACs repo as an example
import org.kotlincrypto.macs.HmacSHA256
// Using HmacSHA3_256 from the MACs repo as an example
import org.kotlincrypto.macs.hmac.sha3.HmacSHA3_256

fun main() {
val key = SecureRandom().nextBytesOf(100)
val mac = HmacSHA256(key)
val mac = HmacSHA3_256(key)
val bytes = Random.Default.nextBytes(615)

// Mac implements Algorithm
Expand Down Expand Up @@ -218,7 +218,7 @@ The best way to keep `KotlinCrypto` dependencies up to date is by using the
```kotlin
// build.gradle.kts
dependencies {
val core = "0.2.7"
val core = "0.3.0"
implementation("org.kotlincrypto.core:digest:$core")
implementation("org.kotlincrypto.core:mac:$core")
implementation("org.kotlincrypto.core:xof:$core")
Expand All @@ -230,15 +230,15 @@ dependencies {
```groovy
// build.gradle
dependencies {
def core = "0.2.7"
def core = "0.3.0"
implementation "org.kotlincrypto.core:digest:$core"
implementation "org.kotlincrypto.core:mac:$core"
implementation "org.kotlincrypto.core:xof:$core"
}
```

<!-- TAG_VERSION -->
[badge-latest-release]: https://img.shields.io/badge/latest--release-0.2.7-blue.svg?style=flat
[badge-latest-release]: https://img.shields.io/badge/latest--release-0.3.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 gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ POM_DEVELOPER_ID=KotlinCrypto
POM_DEVELOPER_NAME=Kotlin Crypto
POM_DEVELOPER_URL=https://github.com/KotlinCrypto/

VERSION_NAME=0.3.0-SNAPSHOT
VERSION_NAME=0.3.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
2 changes: 1 addition & 1 deletion gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
android = "7.4.2"
androidxTestRunner = "1.5.2"
binaryCompat = "0.13.2"
configuration = "0.1.0"
configuration = "0.1.1"
endians = "0.1.0"
gradleVersions = "0.46.0"
kotlin = "1.8.21"
Expand Down

0 comments on commit 5e1f6e7

Please sign in to comment.