Skip to content

Commit

Permalink
chore: update changelog and versioning for 2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruno Paiva Lima da Silva committed Nov 6, 2023
1 parent 80577ed commit 1aacb93
Show file tree
Hide file tree
Showing 14 changed files with 42 additions and 21 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,25 @@ 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.0] - 2023-11-23
### :magic_wand: Added
- Endpoint override for the AWS Secrets Manager plugin ([PR #707](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/707)).
- Allow users to set up a lambda to initialize new connections ([PR #705](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/705)).
- Introduced `Dialect.prepareConnectProperties` to allow dialect classes to modify connection properties when opening a new connection ([PR #704](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/704)).
- Native telemetry support ([PR #617](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/617)).
- Documentation on known limitations with global databases ([PR #695](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/695)).

### :bug: Fixed
- Continue monitoring if unhandled Exception is thrown ([PR #676](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/676)).
- Password properties are now masked in logs ([PR #701](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/701) and [PR #723](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/723)).
- Issue when getting a connection for a closed statement ([PR #682](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/682)).
- Maven coordinates in README ([PR #681](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/681)).
- Update topology for specific methods ([PR #683](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/683)).

### :crab: Changed
- Added buffer to IAM token expiry and moved token expiry time creation ([PR #706](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/706)).
- Documentation on known limitations with Blue/Green deployments ([PR #680](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/680)).

## [2.2.5] - 2023-10-03
### :magic_wand: Added
- Optional preservation of partial session state post failover ([PR #632](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/632)).
Expand Down Expand Up @@ -190,6 +209,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.3.0]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.2.4...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
Expand Down
3 changes: 2 additions & 1 deletion Maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
| 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) |

``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 @@ -68,4 +69,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.2.5 | Current | Apr 28, 2023 | N/A | N/A |
| 2 | 2.3.0 | 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.2.5-jmh.jar`.
2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.3.0-jmh.jar`.
1. you may have to update the command based on the exact version of the produced JAR file
12 changes: 6 additions & 6 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.2.5'
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.0'
implementation group: 'org.postgresql', name: 'postgresql', version: '42.5.0'
}
```
Expand All @@ -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.2.5/aws-advanced-jdbc-wrapper-2.2.5.jar
wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.3.0/aws-advanced-jdbc-wrapper-2.3.0.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.2.5.jar
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.3.0.jar
```

### As a Maven Dependency
Expand All @@ -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.2.5</version>
<version>2.3.0</version>
</dependency>
</dependencies>
```
Expand All @@ -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.2.5'
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.0'
}
```

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

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

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 @@ -159,7 +159,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.2.6-SNAPSHOT</version>
<version>2.3.1-SNAPSHOT</version>
<scope>system</scope>
<systemPath>path-to-snapshot-jar</systemPath>
</dependency>
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.2.5
> - AWS JDBC Driver 2.3.0
> - 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 Advanced JDBC Driver 2.2.5
> - AWS Advanced JDBC Driver 2.3.0
> - 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.2.5
> - AWS JDBC Driver 2.3.0
> - 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.2.5
> - AWS JDBC Driver 2.3.0
> - 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.2.5.jar
│ │ └───aws-advanced-jdbc-wrapper-2.3.0.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.2.5.jar"/>
<resource-root path="aws-advanced-jdbc-wrapper-2.3.0.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.2.5.jar"/>
<resource-root path="aws-advanced-jdbc-wrapper-2.3.0.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.2.5
> - AWS JDBC Driver 2.3.0
> - PostgreSQL 42.5.4
> - Java 8
> - Vert.x 4.4.2
Expand Down
4 changes: 2 additions & 2 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.

aws-advanced-jdbc-wrapper.version.major=2
aws-advanced-jdbc-wrapper.version.minor=2
aws-advanced-jdbc-wrapper.version.subminor=5
aws-advanced-jdbc-wrapper.version.minor=3
aws-advanced-jdbc-wrapper.version.subminor=0
snapshot=false
nexus.publish=true
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.2.5.jar')
testImplementation files('/app/libs/aws-advanced-jdbc-wrapper-2.3.0.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.2.5.jar')
testRuntimeOnly files('/app/libs/aws-advanced-jdbc-wrapper-2.3.0.jar')
testRuntimeOnly dbLibs.mysql

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

0 comments on commit 1aacb93

Please sign in to comment.