Skip to content

Commit 1c84847

Browse files
committed
Prepare 0.1.0 release
1 parent bdba2d5 commit 1c84847

File tree

4 files changed

+13
-5
lines changed

4 files changed

+13
-5
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# CHANGELOG
22

3-
## Version 0.1.0 (2023-03-08)
3+
## Version 0.1.0 (2023-03-04)
44
- Initial Release

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323

2424
Low level core cryptographic components for Kotlin Multiplatform
2525

26+
If you are looking for Hashing algorithms (e.g. `SHA-256`, `SHA-512`, etc), see the [hash repo][url-hash].
27+
2628
### Get Started
2729

2830
<!-- TAG_VERSION -->
@@ -83,3 +85,4 @@ dependencies {
8385
[url-latest-release]: https://github.com/KotlinCrypto/core/releases/latest
8486
[url-license]: https://www.apache.org/licenses/LICENSE-2.0.txt
8587
[url-kotlin]: https://kotlinlang.org
88+
[url-hash]: https://github.com/KotlinCrypto/hash

RELEASING.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ git checkout -b release_"$VERSION_NAME"
3131
```bash
3232
git add --all
3333
git commit -S -m "Prepare $VERSION_NAME release"
34-
git tag -s $VersionName -m "Release v$VERSION_NAME"
34+
git tag -s "$VERSION_NAME" -m "Release v$VERSION_NAME"
3535
```
3636

3737
- Make sure you have valid credentials in `~/.gradle/gradle.properties`
@@ -81,15 +81,20 @@ git push -u origin release_"$VERSION_NAME"
8181
- Should ask for PIN to log in
8282

8383
- Sign a random `.txt` file (gpg tty for YubiKey PIN + gradle build don't mix)
84-
```bash
84+
```shell
8585
gpg --sign --armor --detach ~/Documents/hello.txt
8686
```
8787

8888
- Ensure java version is greater than or equal to 11
89-
```bash
89+
```shell
9090
java --version
9191
```
9292

93+
- Ensure you are in a `bash` shell
94+
```shell
95+
bash
96+
```
97+
9398
- Set version variable in terminal shell
9499
```bash
95100
VERSION_NAME="<version name>"

gradle.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ POM_DEVELOPER_ID=KotlinCrypto
2929
POM_DEVELOPER_NAME=Kotlin Crypto
3030
POM_DEVELOPER_URL=https://github.com/KotlinCrypto/
3131

32-
VERSION_NAME=0.1.0-SNAPSHOT
32+
VERSION_NAME=0.1.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)