Skip to content

Commit

Permalink
Update changelog and bump version for 2.5.4
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronchung-bitquill committed Dec 23, 2024
1 parent b680b4a commit 01bcfac
Show file tree
Hide file tree
Showing 16 changed files with 37 additions and 27 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ 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.5.4] - 2024-12-23
### :bug: Fixed
- Avoid setting ignoreNewTopologyRequestsEndTimeNano on initial connection ([PR #1221](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1221)).
- Limitless Connection Plugin set round-robin weights properly to original properties, not a copy ([PR #1223](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1223)).

### :crab: Changed
- Update dependencies to address [CVE-2024-47535](https://www.cve.org/CVERecord?id=CVE-2024-47535) ([Issue #1229](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/1229)).

## [2.5.3] - 2024-11-29
### :magic_wand: Added
- Add WRITER custom endpoint type ([PR #1202](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1202)).
Expand Down Expand Up @@ -396,6 +404,7 @@ 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.5.4]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.5.3...2.5.4
[2.5.3]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.5.2...2.5.3
[2.5.2]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.5.1...2.5.2
[2.5.1]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.5.0...2.5.1
Expand Down
3 changes: 2 additions & 1 deletion Maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
| October 24, 2024 | [Release 2.5.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.1) |
| November 5, 2024 | [Release 2.5.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.2) |
| November 29, 2024 | [Release 2.5.3](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.3) |
| December 23, 2024 | [Release 2.5.4](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.4) |

`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
Expand Down Expand Up @@ -82,4 +83,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.5.3 | Current | Apr 28, 2023 | N/A | N/A |
| 2 | 2.5.4 | Current | Apr 28, 2023 | N/A | N/A |
2 changes: 1 addition & 1 deletion benchmarks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.3-jmh.jar`.
2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.5.4-jmh.jar`.
1. you may have to update the command based on the exact version of the produced JAR file
14 changes: 7 additions & 7 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.3'
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.5.4'
implementation group: 'org.postgresql', name: 'postgresql', version: '42.5.0'
}
```
Expand All @@ -30,16 +30,16 @@ 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.5.3/aws-advanced-jdbc-wrapper-2.5.3.jar
wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.5.4/aws-advanced-jdbc-wrapper-2.5.4.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.5.3.jar
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.5.4.jar
```

> **Note**: There is also a JAR suffixed with `-bundle-federated-auth`. It is an Uber JAR that contains the AWS JDBC Driver as well as all the dependencies needed to run the Federated Authentication Plugin. **Our general recommendation is to use the `aws-advanced-jdbc-wrapper-2.5.3.jar` for use cases unrelated to complex Federated Authentication environments**. To learn more, please check out the [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar).
> **Note**: There is also a JAR suffixed with `-bundle-federated-auth`. It is an Uber JAR that contains the AWS JDBC Driver as well as all the dependencies needed to run the Federated Authentication Plugin. **Our general recommendation is to use the `aws-advanced-jdbc-wrapper-2.5.4.jar` for use cases unrelated to complex Federated Authentication environments**. To learn more, please check out the [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar).
### As a Maven Dependency

Expand All @@ -50,7 +50,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.5.3</version>
<version>2.5.4</version>
</dependency>
</dependencies>
```
Expand All @@ -61,15 +61,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.5.3'
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.5.4'
}
```

To add a Gradle dependency in a Kotlin syntax, use the following configuration:

```kotlin
dependencies {
implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.5.3")
implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.5.4")
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/using-the-jdbc-driver/UsingTheJdbcDriver.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,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.5.4-SNAPSHOT</version>
<version>2.5.5-SNAPSHOT</version>
<scope>system</scope>
<systemPath>path-to-snapshot-jar</systemPath>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This JAR is a drop-in ready solution and is **recommended for customers who do n
As this plugin has a number of transitive dependencies, the goal of this JAR is to eliminate the need to manually source all the dependencies and avoid potential issues with managing them.
In that spirit, the dependencies in this JAR are shaded with the prefix `shaded` to avoid potential package conflicts with pre-existing packages in your environment.

It is important to note that the Uber JAR is bundled with the AWS Java RDS SDK and is larger (**15 MB**) than our `aws-advanced-jdbc-wrapper-2.5.3.jar`. So please take that into account when deciding if this solution is for you.
It is important to note that the Uber JAR is bundled with the AWS Java RDS SDK and is larger (**15 MB**) than our `aws-advanced-jdbc-wrapper-2.5.4.jar`. So please take that into account when deciding if this solution is for you.

If you would like to download and install the bundled Uber JAR, follow these [instructions](../../GettingStarted.md#direct-download-and-installation).

Expand Down
2 changes: 1 addition & 1 deletion examples/SpringBootHikariExample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.3
> - AWS JDBC Driver 2.5.4
> - Postgresql 42.5.4
> - Java 8
Expand Down
2 changes: 1 addition & 1 deletion examples/SpringHibernateExample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 JDBC Driver 2.5.3
> - AWS JDBC Driver 2.5.4
> - Postgresql 42.5.4
> - Gradle 7
> - Java 11
Expand Down
2 changes: 1 addition & 1 deletion examples/SpringTxFailoverExample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.3
> - AWS JDBC Driver 2.5.4
> - Postgresql 42.5.4
> - Java 8
Expand Down
6 changes: 3 additions & 3 deletions examples/SpringWildflyExample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.3
> - AWS JDBC Driver 2.5.4
> - Postgresql 42.5.4
> - Gradle 7
> - Java 11
Expand Down Expand Up @@ -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.5.3.jar
│ │ └───aws-advanced-jdbc-wrapper-2.5.4.jar
└───standalone
├───configuration
├───amazon
Expand Down Expand Up @@ -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.5.3.jar"/>
<resource-root path="aws-advanced-jdbc-wrapper-2.5.4.jar"/>
<resource-root path="postgresql-42.5.4.jar"/>
</resources>
</module>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<module xmlns="urn:jboss:module:1.1" name="software.amazon.jdbc">

<resources>
<resource-root path="aws-advanced-jdbc-wrapper-2.5.3.jar"/>
<resource-root path="aws-advanced-jdbc-wrapper-2.5.4.jar"/>
<resource-root path="postgresql-42.5.4.jar"/>
</resources>
</module>
2 changes: 1 addition & 1 deletion examples/VertxExample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
In this tutorial, you will set up a Vert.x application with the AWS JDBC Driver, and use the driver to execute some simple database operations on an Aurora PostgreSQL database.

> Note: this tutorial was written using the following technologies:
> - AWS JDBC Driver 2.5.3
> - AWS JDBC Driver 2.5.4
> - PostgreSQL 42.5.4
> - Java 8
> - Vert.x 4.4.2
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

aws-advanced-jdbc-wrapper.version.major=2
aws-advanced-jdbc-wrapper.version.minor=5
aws-advanced-jdbc-wrapper.version.subminor=3
aws-advanced-jdbc-wrapper.version.subminor=4
snapshot=false
nexus.publish=true

Expand Down
10 changes: 5 additions & 5 deletions wrapper/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ plugins {
dependencies {
implementation("org.checkerframework:checker-qual:3.48.1")
compileOnly("org.apache.httpcomponents:httpclient:4.5.14")
compileOnly("software.amazon.awssdk:rds:2.29.29")
compileOnly("software.amazon.awssdk:auth:2.29.29") // Required for IAM (light implementation)
compileOnly("software.amazon.awssdk:http-client-spi:2.29.29") // Required for IAM (light implementation)
compileOnly("software.amazon.awssdk:sts:2.29.29")
compileOnly("software.amazon.awssdk:rds:2.29.34")
compileOnly("software.amazon.awssdk:auth:2.29.34") // Required for IAM (light implementation)
compileOnly("software.amazon.awssdk:http-client-spi:2.29.34") // Required for IAM (light implementation)
compileOnly("software.amazon.awssdk:sts:2.29.34")
compileOnly("com.zaxxer:HikariCP:4.0.3") // Version 4.+ is compatible with Java 8
compileOnly("software.amazon.awssdk:secretsmanager:2.29.29")
compileOnly("software.amazon.awssdk:secretsmanager:2.29.34")
compileOnly("com.fasterxml.jackson.core:jackson-databind:2.17.1")
compileOnly("com.mysql:mysql-connector-j:8.3.0")
compileOnly("org.postgresql:postgresql:42.7.4")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ dependencies {
transitive = true
}
testImplementation "joda-time:joda-time:2.3"
testImplementation files('/app/libs/aws-advanced-jdbc-wrapper-2.5.3.jar')
testImplementation files('/app/libs/aws-advanced-jdbc-wrapper-2.5.4.jar')
testImplementation dbLibs.postgresql
testImplementation dbLibs.mysql
testImplementation dbLibs.h2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ dependencies {
// Since both the DB2 driver and HANA have a package "net.jpountz" we have to add dependencies conditionally
// This is due to the "no split-packages" requirement of Java 9+

testRuntimeOnly files('/app/libs/aws-advanced-jdbc-wrapper-2.5.3.jar')
testRuntimeOnly files('/app/libs/aws-advanced-jdbc-wrapper-2.5.4.jar')
testRuntimeOnly dbLibs.mysql

if ( db.startsWith( 'db2' ) ) {
Expand Down

0 comments on commit 01bcfac

Please sign in to comment.