From 66b3203e61c34818cc840005268cac2c42f0c3d7 Mon Sep 17 00:00:00 2001
From: Kyle Roe <hopeman15@users.noreply.github.com>
Date: Thu, 31 Oct 2024 17:50:57 +0100
Subject: [PATCH] [Prepare] Release Version 1.5.0 (#387)

* update readme

* update documentation

* updated changelog

---------

Co-authored-by: Kyle Roe <[hopeman15@users.noreply.github.com]>
---
 README.md                                        | 16 ++++++++--------
 website/docs/changelog.md                        |  9 +++++++++
 .../docs/getting-started/gradle-dependency.md    |  4 ++--
 website/docs/introduction.md                     |  8 ++++----
 website/docs/supported-types/ubyte.md            |  2 +-
 website/docs/supported-types/uint.md             |  2 +-
 website/docs/supported-types/ulong.md            |  2 +-
 website/docs/supported-types/ushort.md           |  2 +-
 8 files changed, 27 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 27af5dc6..858f28fe 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ Model Forge is a library to automate model generation for automated testing:
 
 ```kotlin
 dependencies {
-    testImplementation("io.github.hellocuriosity:model-forge:1.4.0")
+    testImplementation("io.github.hellocuriosity:model-forge:1.5.0")
 }
 ```
 
@@ -36,7 +36,7 @@ dependencies {
 
 ```groovy
 dependencies {
-    testImplementation 'io.github.hellocuriosity:model-forge:1.4.0'
+    testImplementation 'io.github.hellocuriosity:model-forge:1.5.0'
 }
 ```
 
@@ -55,7 +55,7 @@ repositories {
 }
 
 dependencies {
-    testImplementation("io.github.hellocuriosity:model-forge:1.4.0.xx-SNAPSHOT")
+    testImplementation("io.github.hellocuriosity:model-forge:1.5.0.xx-SNAPSHOT")
 }
 ```
 
@@ -70,7 +70,7 @@ repositories {
 }
 
 dependencies {
-    testImplementation 'io.github.hellocuriosity:model-forge:1.4.0.xx-SNAPSHOT'
+    testImplementation 'io.github.hellocuriosity:model-forge:1.5.0.xx-SNAPSHOT'
 }
 ```
 
@@ -180,10 +180,10 @@ Model Forge currently supports the auto generation for the following types:
 * Long
 * Short
 * String
-* UByte (snapshot)
-* UInt (snapshot)
-* ULong (snapshot)
-* UShort (snapshot)
+* UByte
+* UInt
+* ULong
+* UShort
 * UUID
 
 ### Collections
diff --git a/website/docs/changelog.md b/website/docs/changelog.md
index 4159aad3..ca3d0691 100644
--- a/website/docs/changelog.md
+++ b/website/docs/changelog.md
@@ -4,6 +4,15 @@ sidebar_position: 4
 
 # Changelog
 
+## [1.5.0] - October 31st 2024
+
+* Auto generation for additional types:
+    * UByte
+    * UInt
+    * ULong
+    * UShort
+* Dependency updates
+
 ## [1.4.0] - February 19th 2024
 
 * Support Kotlin version 1.9.22
diff --git a/website/docs/getting-started/gradle-dependency.md b/website/docs/getting-started/gradle-dependency.md
index a31cd033..169a05f8 100644
--- a/website/docs/getting-started/gradle-dependency.md
+++ b/website/docs/getting-started/gradle-dependency.md
@@ -8,7 +8,7 @@ Add the dependency to your `build.gradle` file to get started:
 
 ```kotlin
 dependencies {
-    testImplementation("io.github.hellocuriosity:model-forge:1.4.0")
+    testImplementation("io.github.hellocuriosity:model-forge:1.5.0")
 }
 ```
 
@@ -22,6 +22,6 @@ repositories {
 }
 
 dependencies {
-    testImplementation("io.github.hellocuriosity:model-forge:1.4.0.xx-SNAPSHOT")
+    testImplementation("io.github.hellocuriosity:model-forge:1.5.0.xx-SNAPSHOT")
 }
 ```
diff --git a/website/docs/introduction.md b/website/docs/introduction.md
index 2753b8ca..da72a222 100644
--- a/website/docs/introduction.md
+++ b/website/docs/introduction.md
@@ -23,10 +23,10 @@ supports the auto generation for the following types:
 * Long
 * Short
 * String
-* UByte (snapshot)
-* UInt (snapshot)
-* ULong (snapshot)
-* UShort (snapshot)
+* UByte
+* UInt
+* ULong
+* UShort
 * UUID
 
 #### Collections
diff --git a/website/docs/supported-types/ubyte.md b/website/docs/supported-types/ubyte.md
index 6fe002fd..7af880f5 100644
--- a/website/docs/supported-types/ubyte.md
+++ b/website/docs/supported-types/ubyte.md
@@ -2,7 +2,7 @@
 sidebar_position: 15
 ---
 
-# UByte (Snapshot)
+# UByte
 
 The `UByte` provider generates a random UByte value between two unsigned integers.
 
diff --git a/website/docs/supported-types/uint.md b/website/docs/supported-types/uint.md
index 8407e4be..fe8595e7 100644
--- a/website/docs/supported-types/uint.md
+++ b/website/docs/supported-types/uint.md
@@ -2,7 +2,7 @@
 sidebar_position: 16
 ---
 
-# UInt (Snapshot)
+# UInt
 
 The `UInt` provider generates a random UInt value between two unsigned integers.
 
diff --git a/website/docs/supported-types/ulong.md b/website/docs/supported-types/ulong.md
index 6242cd39..79b23343 100644
--- a/website/docs/supported-types/ulong.md
+++ b/website/docs/supported-types/ulong.md
@@ -2,7 +2,7 @@
 sidebar_position: 17
 ---
 
-# ULong (Snapshot)
+# ULong
 
 The `ULong` provider generates a random ULong value between two unsigned longs.
 
diff --git a/website/docs/supported-types/ushort.md b/website/docs/supported-types/ushort.md
index cde991ab..6e7e576c 100644
--- a/website/docs/supported-types/ushort.md
+++ b/website/docs/supported-types/ushort.md
@@ -2,7 +2,7 @@
 sidebar_position: 18
 ---
 
-# UShort (Snapshot)
+# UShort
 
 The `UShort` provider generates a random UShort value between two unsigned integers.