Skip to content

Commit

Permalink
chore: update changelog and versioning for 1.1.14 release (#558)
Browse files Browse the repository at this point in the history
* update changelog

* update versioning

* small typo

* update from review comments
  • Loading branch information
jasonlamz authored Mar 4, 2024
1 parent 090d835 commit 5264adb
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 28 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).

## [1.1.14] - 2024-03-04
### Added
* Documentation regarding the differences between the AWS JDBC Driver and the AWS JDBC Driver for MySQL ([PR #554](https://github.com/awslabs/aws-mysql-jdbc/pull/554)).
* Support for China endpoint patterns ([PR #543](https://github.com/awslabs/aws-mysql-jdbc/pull/543)).

### Fixed
* Statement cancel waits for statement to finish before cancelling ([Issue #527](https://github.com/awslabs/aws-mysql-jdbc/issues/527)).

## [1.1.13] - 2024-01-19
### Changed
* Upstream changes from MySQL 8.0.32 and 8.0.33 community driver. The upstream 8.0.33 changes include a security fix for [CVE-2023-21971 - RCE and Unauthorized DB Access](https://github.com/awslabs/aws-mysql-jdbc/security/advisories/GHSA-vj9v-mpjv-qf74).
Expand Down Expand Up @@ -191,6 +199,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
### Added
* This driver is based on the MySQL 8.0.21 community driver. The driver is cluster aware for Amazon Aurora MySQL. It takes advantage of Amazon Aurora's fast failover capabilities, reducing failover times from minutes to seconds.

[1.1.14]: https://github.com/awslabs/aws-mysql-jdbc/compare/1.1.13...1.1.14
[1.1.13]: https://github.com/awslabs/aws-mysql-jdbc/compare/1.1.12...1.1.13
[1.1.12]: https://github.com/awslabs/aws-mysql-jdbc/compare/1.1.11...1.1.12
[1.1.11]: https://github.com/awslabs/aws-mysql-jdbc/compare/1.1.10...1.1.11
Expand Down
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,18 @@ The AWS JDBC Driver for MySQL can be installed from pre-compiled packages that c

**Example - Direct download with wget**
```bash
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.13/aws-mysql-jdbc-1.1.13.jar
cp aws-mysql-jdbc-1.1.13.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.13.jar
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.14/aws-mysql-jdbc-1.1.14.jar
cp aws-mysql-jdbc-1.1.14.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.14.jar
```

**Upgrading to a newer version with wget**

To upgrade the driver, replace the .jar file of your earlier driver with the new `.jar` file. After replacing the `.jar` file, update the CLASSPATH to include the name of the new file. For example, to upgrade to version 1.1.13:
To upgrade the driver, replace the .jar file of your earlier driver with the new `.jar` file. After replacing the `.jar` file, update the CLASSPATH to include the name of the new file. For example, to upgrade to version 1.1.14:
```bash
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.13/aws-mysql-jdbc-1.1.13.jar
cp aws-mysql-jdbc-1.1.13.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.13.jar
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.14/aws-mysql-jdbc-1.1.14.jar
cp aws-mysql-jdbc-1.1.14.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.14.jar
```

#### As a Maven dependency
Expand All @@ -61,20 +61,20 @@ You can use [Maven's dependency management](https://central.sonatype.com/search?
<dependency>
<groupId>software.aws.rds</groupId>
<artifactId>aws-mysql-jdbc</artifactId>
<version>1.1.13</version>
<version>1.1.14</version>
</dependency>
</dependencies>
```

**Upgrading to a newer version with Maven**

To upgrade to a newer version of the driver, replace the version number identified in the `pom.xml` file with the newer driver version. For example, to upgrade to version 1.1.13, modify the file to include:
To upgrade to a newer version of the driver, replace the version number identified in the `pom.xml` file with the newer driver version. For example, to upgrade to version 1.1.14, modify the file to include:
```xml
<dependencies>
<dependency>
<groupId>software.aws.rds</groupId>
<artifactId>aws-mysql-jdbc</artifactId>
<version>1.1.13</version>
<version>1.1.14</version>
</dependency>
</dependencies>
```
Expand All @@ -85,16 +85,16 @@ You can use [Gradle's dependency management](https://central.sonatype.com/search
**Example - Gradle**
```gradle
dependencies {
implementation group: 'software.aws.rds', name: 'aws-mysql-jdbc', version: '1.1.13'
implementation group: 'software.aws.rds', name: 'aws-mysql-jdbc', version: '1.1.14'
}
```

**Upgrading to a newer version with Gradle**

To upgrade to a newer version of the driver, replace the version number identified in the application's ```build.gradle``` file with the newer driver version. For example, to upgrade to version 1.1.13:
To upgrade to a newer version of the driver, replace the version number identified in the application's ```build.gradle``` file with the newer driver version. For example, to upgrade to version 1.1.14:
```gradle
dependencies {
implementation group: 'software.aws.rds', name: 'aws-mysql-jdbc', version: '1.1.13'
implementation group: 'software.aws.rds', name: 'aws-mysql-jdbc', version: '1.1.14'
}
```

Expand All @@ -104,9 +104,9 @@ To use the driver with an IDE (for example, IntelliJ), download the `.jar` file
**Example - IntelliJ**

```bash
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.13/aws-mysql-jdbc-1.1.13.jar
cp aws-mysql-jdbc-1.1.13.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.13.jar
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.14/aws-mysql-jdbc-1.1.14.jar
cp aws-mysql-jdbc-1.1.14.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.14.jar
```

After downloading the `.jar` file and updating the CLASSPATH, add the driver information to your `Project`:
Expand All @@ -126,9 +126,9 @@ After downloading the `.jar` file and updating the CLASSPATH, add the driver inf
To upgrade to a newer version of the driver, download the updated driver, and add it to your CLASSPATH:

```bash
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.13/aws-mysql-jdbc-1.1.13.jar
cp aws-mysql-jdbc-1.1.13.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.13.jar
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.14/aws-mysql-jdbc-1.1.14.jar
cp aws-mysql-jdbc-1.1.14.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.14.jar
```

Then, follow the steps listed above to update your project to the latest version.
Expand All @@ -140,9 +140,9 @@ To use the driver with the DBeaver database client, download the `.jar` file, co
**Example - DBeaver**

```bash
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.13/aws-mysql-jdbc-1.1.13.jar
cp aws-mysql-jdbc-1.1.13.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.13.jar
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1.14/aws-mysql-jdbc-1.1.14.jar
cp aws-mysql-jdbc-1.1.14.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.14.jar
```

After downloading the .jar file and adding it to your CLASSPATH, add the driver information to the DBeaver client:
Expand Down Expand Up @@ -185,9 +185,9 @@ After adding driver information, you can create new connections that use the AWS
To upgrade to a newer version of the driver, download the updated driver, and add it to your CLASSPATH:
```bash
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1./aws-mysql-jdbc-1.1.13.jar
cp aws-mysql-jdbc-1.1.13.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.13.jar
wget https://github.com/awslabs/aws-mysql-jdbc/releases/download/1.1./aws-mysql-jdbc-1.1.14.jar
cp aws-mysql-jdbc-1.1.14.jar /home/userx/libs/
export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-mysql-jdbc-1.1.14.jar
```
Then, follow the steps listed above to update your DBeaver client settings.
Expand All @@ -200,7 +200,7 @@ If there is an unreleased feature you would like to try, it may be available in
<dependency>
<groupId>software.aws.rds</groupId>
<artifactId>aws-mysql-jdbc</artifactId>
<version>1.1.14</version>
<version>1.1.15</version>
<scope>system</scope>
<systemPath>path-to-snapshot-jar</systemPath>
</dependency>
Expand Down
3 changes: 2 additions & 1 deletion RELEASE_POLICY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
| November 2, 2023 | [Release 1.1.11](https://github.com/awslabs/aws-mysql-jdbc/releases/tag/1.1.11) |
| December 21, 2023 | [Release 1.1.12](https://github.com/awslabs/aws-mysql-jdbc/releases/tag/1.1.12) |
| January 19, 2024 | [Release 1.1.13](https://github.com/awslabs/aws-mysql-jdbc/releases/tag/1.1.13) |
| March 4, 2024 | [Release 1.1.14](https://github.com/awslabs/aws-mysql-jdbc/releases/tag/1.1.14) |


aws-mysql-jdbc-driver [follows semver](https://semver.org/#semantic-versioning-200) which means we will only release
Expand Down Expand Up @@ -57,4 +58,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.0 | Maintenance | Mar 1, 2022 | June 29, 2022 | June 29, 2023 |
| 2 | 1.1.12 | Current | June 28, 2023 | July 25, 2023 | July 25, 2024 |
| 2 | 1.1.14 | Current | June 28, 2023 | July 25, 2023 | July 25, 2024 |
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ spotbugs.version=4.0.0
# Build properties
com.mysql.cj.build.driver.version.major=1
com.mysql.cj.build.driver.version.minor=1
com.mysql.cj.build.driver.version.subminor=13
com.mysql.cj.build.driver.version.subminor=14
com.mysql.cj.build.driver.displayName=Amazon Web Services (AWS) JDBC Driver for MySQL
com.mysql.cj.build.driver.name=aws-mysql-connector-java
com.mysql.cj.build.licenseType=GPLv2
Expand Down

0 comments on commit 5264adb

Please sign in to comment.