Skip to content

Commit

Permalink
Update versioning and changelog for version 2.2.3 (#566)
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronchung-bitquill authored Jul 21, 2023
1 parent cb90b36 commit e37c681
Show file tree
Hide file tree
Showing 13 changed files with 31 additions and 19 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ 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.2.3] - 2023-07-28
### :magic_wand: Added
- Developer plugin to help test various scenarios including events like network outages and database cluster failover. This plugin is NOT intended to be used in production environments and is only for testing ([PR #531](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/531)).
- Documentation:
- Developer plugin. See [UsingTheJdbcDriver](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#list-of-available-plugins) and [UsingTheDeveloperPlugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheDeveloperPlugin.md).
- MySQL code samples ([PR #532](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/532)).
- Add a Table of Contents section for the sample codes on README.md. See [README.md](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/README.md#examples).
- Sample tutorial and code example for Vert.x. See the [tutorial](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/examples/VertxExample/README.md) and [code example](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/examples/VertxExample/src/main/java/com/example/starter/MainVerticle.java).
- Added Properties section on the README listing all the driver properties and where they are used. See the [README.md](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/README.md#properties)

## [2.2.2] - 2023-07-05
### :magic_wand: Added
- Official support for Amazon Aurora with MySQL compatibility. The AWS JDBC Driver has been validated to support [MySQL JDBC Driver](https://github.com/mysql/mysql-connector-j) and [MariaDB JDBC Driver](https://github.com/mariadb-corporation/mariadb-connector-j).
Expand Down Expand Up @@ -149,6 +159,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.2.3]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.2.2...2.2.3
[2.2.2]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.2.1...2.2.2
[2.2.1]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.2.0...2.2.1
[2.2.0]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.1.2...2.2.0
Expand Down
3 changes: 2 additions & 1 deletion Maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
| 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 28, 2023 | [Release 2.2.3](https://github.com/awslabs/`aws-advanced-jdbc-wrapper`/releases/tag/2.2.3) |

``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 @@ -65,4 +66,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.2 | Current | Apr 28, 2023 | N/A | N/A |
| 2 | 2.2.3 | 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.2-jmh.jar`.
2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.2.3-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 @@ -14,7 +14,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.2'
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.2.3'
implementation group: 'org.postgresql', name: 'postgresql', version: '42.5.0'
}
```
Expand All @@ -28,13 +28,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.2/aws-advanced-jdbc-wrapper-2.2.2.jar
wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.2.3/aws-advanced-jdbc-wrapper-2.2.3.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.2.jar
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.2.3.jar
```

### As a Maven Dependency
Expand All @@ -46,7 +46,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>LATEST</version>
<version>2.2.3</version>
</dependency>
</dependencies>
```
Expand All @@ -57,15 +57,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.2'
implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.2.3'
}
```

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.2")
implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.2.3")
}
```

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 @@ -135,7 +135,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.2-SNAPSHOT</version>
<version>2.2.3-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 Advanced JDBC Wrapper 2.2.2
> - AWS Advanced JDBC Wrapper 2.2.3
> - 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.2
> - AWS Advanced JDBC Driver 2.2.3
> - Postgresql 42.5.4
> - Gradle 7
> - Java 11
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 Advanced JDBC Wrapper 2.2.2
> - AWS Advanced JDBC Wrapper 2.2.3
> - 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.2.jar
│ │ └───aws-advanced-jdbc-wrapper-2.2.3.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.2.jar"/>
<resource-root path="aws-advanced-jdbc-wrapper-2.2.3.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.2.jar"/>
<resource-root path="aws-advanced-jdbc-wrapper-2.2.3.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 Wrapper 2.2.2
> - AWS JDBC Wrapper 2.2.3
> - 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,6 +14,6 @@

aws-advanced-jdbc-wrapper.version.major=2
aws-advanced-jdbc-wrapper.version.minor=2
aws-advanced-jdbc-wrapper.version.subminor=2
aws-advanced-jdbc-wrapper.version.subminor=3
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.2.jar')
testImplementation files('/app/libs/aws-advanced-jdbc-wrapper-2.2.3.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.2.jar')
testRuntimeOnly files('/app/libs/aws-advanced-jdbc-wrapper-2.2.3.jar')
testRuntimeOnly dbLibs.mysql

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

0 comments on commit e37c681

Please sign in to comment.