chore: update changelog and versioning for version 2.3.1

Author: crystall-bitquill

CHANGELOG.md

@@ -3,6 +3,20 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/#semantic-versioning-200).
 
+## [2.3.1] - 2023-11-27
+### :magic_wand: Added
+- User defined session state transfer functions ([PR #729](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/729)).
+- Documentation for using the driver with RDS Multi-AZ database clusters ([PR #740](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/740)).
+- [Configuration profiles](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#configuration-profiles) and [configuration presets](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/ConfigurationPresets.md) ([PR #711](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/711) and [PR #738](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/738)).
+
+### :bug: Fixed
+- Stopped monitoring threads causing out of memory errors ([PR #718](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/718)).
+- Automatically register a target driver in the class path to prevent `No suitable driver` SQL exceptions ([PR #748](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/748)).
+
+### :crab: Changed
+- Session state tracking to include additional state information ([PR #729](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/729)).
+- Log level for intentionally ignored exceptions to reduce the number of warnings ([PR #751](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/751)).
+
 ## [2.3.0] - 2023-11-23
 ### :magic_wand: Added
 - Fast switchover support for Amazon RDS Multi-AZ DB Clusters ([PR #690](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/690)).
@@ -210,7 +224,8 @@ The Amazon Web Services (AWS) Advanced JDBC Driver allows an application to take
 - The [AWS IAM Authentication Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
 - The [AWS Secrets Manager Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
 
-[2.3.0]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.2.4...2.3.0
+[2.3.1]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.3.0...2.3.1
+[2.3.0]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.2.5...2.3.0
 [2.2.5]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.2.4...2.2.5
 [2.2.4]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.2.3...2.2.4
 [2.2.3]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.2.2...2.2.3

Maintenance.md

@@ -1,20 +1,21 @@
 # Release Schedule and Maintenance Policy
 
-| Release Date     | Release                                                                                    |
-|------------------|--------------------------------------------------------------------------------------------|
-| October 5, 2022  | [Release 1.0.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/1.0.0) |  
-| January 31, 2023 | [Release 1.0.1](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/1.0.1) | 
-| Mar 30, 2023     | [Release 1.0.2](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/1.0.2) |
-| April 28, 2023   | [Release 2.0.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.0.0) |  
-| May 11, 2023     | [Release 2.1.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.1.0) |
-| May 21, 2023     | [Release 2.1.1](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.1.1) |
-| June 14, 2023    | [Release 2.2.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.0) |
-| June 16, 2023    | [Release 2.2.1](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.1) |
-| July 5, 2023     | [Release 2.2.2](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.2) |
-| July 31, 2023    | [Release 2.2.3](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.3) |
-| August 25, 2023  | [Release 2.2.4](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.4) |
-| October 3, 2023  | [Release 2.2.5](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.5) |
-| November, 2023   | [Release 2.3.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.3.0) |
+| Release Date      | Release                                                                                    |
+|-------------------|--------------------------------------------------------------------------------------------|
+| October 5, 2022   | [Release 1.0.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/1.0.0) |  
+| January 31, 2023  | [Release 1.0.1](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/1.0.1) | 
+| Mar 30, 2023      | [Release 1.0.2](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/1.0.2) |
+| April 28, 2023    | [Release 2.0.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.0.0) |  
+| May 11, 2023      | [Release 2.1.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.1.0) |
+| May 21, 2023      | [Release 2.1.1](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.1.1) |
+| June 14, 2023     | [Release 2.2.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.0) |
+| June 16, 2023     | [Release 2.2.1](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.1) |
+| July 5, 2023      | [Release 2.2.2](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.2) |
+| July 31, 2023     | [Release 2.2.3](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.3) |
+| August 25, 2023   | [Release 2.2.4](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.4) |
+| October 3, 2023   | [Release 2.2.5](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.5) |
+| November 15, 2023 | [Release 2.3.0](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.3.0) |
+| November 27, 2023 | [Release 2.3.1](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.3.1) |
 
 ``aws-advanced-jdbc-wrapper`` [follows semver](https://semver.org/#semantic-versioning-200) which means we will only
 release breaking changes in major versions. Generally speaking patches will be released to fix existing problems without
@@ -69,4 +70,4 @@ from the updated source after the PRs are merged.
 | Major Version | Latest Minor Version | Status      | Initial Release | Maintenance Window Start | Maintenance Window End |
 |---------------|----------------------|-------------|-----------------|--------------------------|------------------------|
 | 1             | 1.0.2                | Maintenance | Oct 5, 2022     | Apr 28, 2023             | Apr 28, 2024           | 
-| 2             | 2.3.0                | Current     | Apr 28, 2023    | N/A                      | N/A                    | 
+| 2             | 2.3.1                | Current     | Apr 28, 2023    | N/A                      | N/A                    | 

benchmarks/README.md

@@ -7,5 +7,5 @@ The benchmarks do not measure the performance of target JDBC drivers nor the per
 ## Usage
 1. Build the benchmarks with the following command `../gradlew jmhJar`.
     1. the JAR file will be outputted to `build/libs`
-2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.3.0-jmh.jar`.
+2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.3.1-jmh.jar`.
     1. you may have to update the command based on the exact version of the produced JAR file

docs/GettingStarted.md

@@ -16,7 +16,7 @@ If you are using the AWS JDBC Driver as part of a Gradle project, include the wr
 
 ```gradle
 dependencies {
-    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.0'
+    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.1'
     implementation group: 'org.postgresql', name: 'postgresql', version: '42.5.0'
 }
 ```
@@ -30,13 +30,13 @@ You can use pre-compiled packages that can be downloaded directly from [GitHub R
 For example, the following command uses wget to download the wrapper:
 
 ```bash
-wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.3.0/aws-advanced-jdbc-wrapper-2.3.0.jar
+wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.3.1/aws-advanced-jdbc-wrapper-2.3.1.jar
 ```
 
 Then, the following command adds the AWS JDBC Driver to the CLASSPATH:
 
 ```bash
-export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.3.0.jar
+export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.3.1.jar
 ```
 
 ### As a Maven Dependency
@@ -48,7 +48,7 @@ You can use [Maven's dependency management](https://search.maven.org/search?q=g:
     <dependency>
         <groupId>software.amazon.jdbc</groupId>
         <artifactId>aws-advanced-jdbc-wrapper</artifactId>
-        <version>2.3.0</version>
+        <version>2.3.1</version>
     </dependency>
 </dependencies>
 ```
@@ -59,15 +59,15 @@ You can use [Gradle's dependency management](https://search.maven.org/search?q=g
 
 ```gradle
 dependencies {
-    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.0'
+    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.1'
 }
 ```
 
 To add a Gradle dependency in a Kotlin syntax, use the following configuration:
 
 ```kotlin
 dependencies {
-    implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.3.0")
+    implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.3.1")
 }
 ```
 

docs/using-the-jdbc-driver/UsingTheJdbcDriver.md

@@ -191,7 +191,7 @@ If there is an unreleased feature you would like to try, it may be available in
   <dependency>
     <groupId>software.amazon.jdbc</groupId>
     <artifactId>aws-advanced-jdbc-wrapper</artifactId>
-    <version>2.3.1-SNAPSHOT</version>
+    <version>2.3.2-SNAPSHOT</version>
     <scope>system</scope>
     <systemPath>path-to-snapshot-jar</systemPath>
   </dependency>

examples/SpringBootHikariExample/README.md

@@ -4,7 +4,7 @@ In this tutorial, you will set up a Spring Boot application using Hikari and the
 
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.0
->    - AWS JDBC Driver 2.3.0
+>    - AWS JDBC Driver 2.3.1
 >    - Postgresql 42.5.4
 >    - Java 8
 

examples/SpringHibernateExample/README.md

@@ -5,7 +5,7 @@ In this tutorial, you will set up a Spring Boot and Hibernate application with t
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.1
 >    - Hibernate
->    - AWS Advanced JDBC Driver 2.3.0
+>    - AWS JDBC Driver 2.3.1
 >    - Postgresql 42.5.4
 >    - Gradle 7
 >    - Java 11

examples/SpringTxFailoverExample/README.md

@@ -4,7 +4,7 @@ In this tutorial, you will set up a Spring Boot application using the AWS JDBC D
 
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.0
->    - AWS JDBC Driver 2.3.0
+>    - AWS JDBC Driver 2.3.1
 >    - Postgresql 42.5.4
 >    - Java 8
 

examples/SpringWildflyExample/README.md

@@ -5,7 +5,7 @@ In this tutorial, you will set up a Wildfly and Spring Boot application with the
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.1
 >    - Wildfly 26.1.1 Final
->    - AWS JDBC Driver 2.3.0
+>    - AWS JDBC Driver 2.3.1
 >    - Postgresql 42.5.4
 >    - Gradle 7
 >    - Java 11
@@ -38,7 +38,7 @@ Create a Gradle project with the following project hierarchy:
               │       └───main
               │       │   │───module.xml
               │       │   │───postgresql-42.5.4.jar
-              │       │   └───aws-advanced-jdbc-wrapper-2.3.0.jar
+              │       │   └───aws-advanced-jdbc-wrapper-2.3.1.jar
       └───standalone
           ├───configuration
               ├───amazon
@@ -135,7 +135,7 @@ Since this example uses the PostgreSQL JDBC driver as the target driver, you nee
 <module xmlns="urn:jboss:module:1.1" name="software.amazon.jdbc">
 
   <resources>
-    <resource-root path="aws-advanced-jdbc-wrapper-2.3.0.jar"/>
+    <resource-root path="aws-advanced-jdbc-wrapper-2.3.1.jar"/>
     <resource-root path="postgresql-42.5.4.jar"/>
   </resources>
 </module>

examples/SpringWildflyExample/wildfly/modules/software/amazon/jdbc/main/module.xml

@@ -19,7 +19,7 @@
 <module xmlns="urn:jboss:module:1.1" name="software.amazon.jdbc">
 
   <resources>
-    <resource-root path="aws-advanced-jdbc-wrapper-2.3.0.jar"/>
+    <resource-root path="aws-advanced-jdbc-wrapper-2.3.1.jar"/>
     <resource-root path="postgresql-42.5.4.jar"/>
   </resources>
 </module>