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 9ab9040 commit e1d8f6f
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 10 deletions.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# CHANGELOG

## Version 0.3.0 (2023-06-28)
- Fixes JPMS split packages [[#40]][40]
- **API BREAKING CHANGES**
- Package names were changed for `hmac`, `hmac-md5`, `hmac-sha1`, `hmac-sha2`, `hmac-sha3`,
and `kmac` modules
- Example:
- `org.kotlincrypto.macs.Hmac` was moved to `org.kotlincrypto.macs.hmac.Hmac`
- `org.kotlincrypto.macs.HmacSHA256` was moved to `org.kotlincrypto.macs.hmac.sha2.HmacSHA256`
- `org.kotlincrypto.macs.HmacSHA3_256` was moved to `org.kotlincrypto.macs.hmac.sha3.HmacSHA3_256`
- `org.kotlincrypto.macs.KMAC128` was moved to `org.kotlincrypto.macs.kmac.KMAC128`
- The MavenCentral dependency `org.kotlincrypto.macs:hmac-md5` is now deprecated,
in favor of `org.kotlincrypto.macs:hmac-md`
- `hmac-md5` dependency now simply provides the `hmac-md` dependency and
will continue to be published until the next major version release.
- The following MavenCentral dependencies (previously deprecated) have
been removed from publication [[#41]][41]
- `org.kotlincrypto.macs:hmac-sha2-256`
- `org.kotlincrypto.macs:hmac-sha2-512`
- `Kmac` performance improvements [[#38]][38]
- See the [ANNOUNCEMENT][discussion-3] for more information on `0.3.0` release

## Version 0.2.7 (2023-06-09)
- Updates `kotlincrypto.core` to `0.2.7` [[#36]][36]
- Fix for Android API 23 and below where `javax.crypto.Mac.doFinal` does
Expand Down Expand Up @@ -62,6 +83,7 @@
## Version 0.1.0 (2023-03-05)
- Initial Release

[discussion-3]: https://github.com/orgs/KotlinCrypto/discussions/3
[core-38]: https://github.com/KotlinCrypto/core/pull/38
[core-44]: https://github.com/KotlinCrypto/core/pull/44
[core-46]: https://github.com/KotlinCrypto/core/pull/46
Expand All @@ -72,3 +94,6 @@
[32]: https://github.com/KotlinCrypto/MACs/pull/32
[33]: https://github.com/KotlinCrypto/MACs/pull/33
[36]: https://github.com/KotlinCrypto/MACs/pull/36
[38]: https://github.com/KotlinCrypto/MACs/pull/38
[40]: https://github.com/KotlinCrypto/MACs/pull/40
[41]: https://github.com/KotlinCrypto/MACs/pull/41
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,17 +118,18 @@ shown below.
// build.gradle.kts
dependencies {
// define the BOM and its version
implementation(platform("org.kotlincrypto.macs:bom:0.2.7"))
implementation(platform("org.kotlincrypto.macs:bom:0.3.0"))

// define artifacts without version

// HmacMD5
implementation("org.kotlincrypto.macs:hmac-md5")
implementation("org.kotlincrypto.macs:hmac-md")

// HmacSHA1
implementation("org.kotlincrypto.macs:hmac-sha1")

// HmacSHA224, HmacSHA256, HmacSHA384, HmacSHA512, HmacSHA512/224, HmacSHA512/256
// HmacSHA224, HmacSHA256, HmacSHA384, HmacSHA512
// HmacSHA512/t, HmacSHA512/224, HmacSHA512/256
implementation("org.kotlincrypto.macs:hmac-sha2")

// HmacKeccak224, HmacKeccak256, HmacKeccak384, HmacKeccak512
Expand All @@ -141,13 +142,13 @@ dependencies {
```

<!-- 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 -->
[badge-kotlin]: https://img.shields.io/badge/kotlin-1.8.21-blue.svg?logo=kotlin
[badge-core]: https://img.shields.io/badge/kotlincrypto.core-0.2.7-blue.svg
[badge-hash]: https://img.shields.io/badge/kotlincrypto.hash-0.2.7-blue.svg
[badge-core]: https://img.shields.io/badge/kotlincrypto.core-0.3.0-blue.svg
[badge-hash]: https://img.shields.io/badge/kotlincrypto.hash-0.3.0-blue.svg

<!-- TAG_PLATFORMS -->
[badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat
Expand Down
4 changes: 2 additions & 2 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ POM_DEVELOPER_ID=KotlinCrypto
POM_DEVELOPER_NAME=Kotlin Crypto
POM_DEVELOPER_URL=https://github.com/KotlinCrypto/

VERSION_NAME=0.2.8-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
# 0.1.0 = 00 01 00 99
# 1.1.0 = 01 01 00 99
VERSION_CODE=20899
VERSION_CODE=30099
4 changes: 2 additions & 2 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ androidxTestRunner = "1.5.2"
binaryCompat = "0.13.2"
bouncyCastle = "1.73"
configuration = "0.1.1"
cryptoCore = "0.3.0-SNAPSHOT"
cryptoHash = "0.3.0-SNAPSHOT"
cryptoCore = "0.3.0"
cryptoHash = "0.3.0"
encoding = "2.0.0"
gradleVersions = "0.46.0"
kotlin = "1.8.21"
Expand Down

0 comments on commit e1d8f6f

Please sign in to comment.