diff --git a/README.md b/README.md index e111e23..3bac177 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,8 @@ Rather than using a local kafka instance, this project can utilize an instance o ## CC Docker Compose File There is a provided docker-compose file (docker-compose-confluent-cloud.yml) that passes the above environment variables into the container that gets created. Further, this file doesn't spin up a local kafka instance since it is not required. +## Release Notes +The current version and release history of the Jpo-s3-deposit: [Jpo-s3-deposit Release Notes]() ## Note This has only been tested with Confluent Cloud but technically all SASL authenticated Kafka brokers can be reached using this method. @@ -128,4 +130,4 @@ A launch.json file with some launch configurations have been included to allow d The values between braces < > are stand-in and need to be replaced by the developer. -To run the project through the launch configuration and start debugging, the developer can navigate to the Run panel (View->Run or Ctrl+Shift+D), select the configuration at the top, and click the green arrow or press F5 to begin. \ No newline at end of file +To run the project through the launch configuration and start debugging, the developer can navigate to the Run panel (View->Run or Ctrl+Shift+D), select the configuration at the top, and click the green arrow or press F5 to begin. diff --git a/docs/Release_notes.md b/docs/Release_notes.md new file mode 100644 index 0000000..ca61441 --- /dev/null +++ b/docs/Release_notes.md @@ -0,0 +1,54 @@ +Jpo-s3-deposit Release Notes +---------------------------- + +Version 1.2.0, released July 5th 2023 +---------------------------------------- + +### **Summary** +The updates for jpo-s3-deposit 1.2.0 include CI/CD and dependency changes. + +Enhancements in this release: +- The JSON version being used has been bumped to 20230227. +- CI/CD has been added. + +Known Issues +- The `run.sh` script incorrectly references the built JAR and does not work at this time. The dockerfile correctly references the built JAR, however, so this is non-critical. + +Version 1.1.0, released Mar 30th 2023 +---------------------------------------- + +### **Summary** +The updates for jpo-s3-deposit 1.1.0 include Confluent Cloud integration, some fixes and documentation improvements. + +Enhancements in this release: +- Ensured response and client objects were closed. +- Allowed the depositor to connect to an instance of Kafka hosted by Confluent Cloud. +- Added docker & dev container files. +- Added a simple run script. +- Added a launch configuration. +- Utilized kafka_2.11 library instead of kafka-clients library. +- Added a section to the README on Confluent Cloud Integration. +- Added sections to the README on the run script and docker-compose files. +- Added a section on launch configurations to the README. +- Updated base image to eclipse-temurin:11-jre-alphine rather than the deprecated openjdk:8-jre-alpine image. +- Updated the version in the pom.xml to 1.1.0 to match the version being used for release. + +Fixes in this release: +- Fixed a bug with Dockerfile not carrying the deposit group name. +- Swapped out bullseye version. +- Removed unnecessary static from AwsDepositor.java. + +Known Issues +- There are no known issues at this time. + +Version 1.0.1, released Mar 8th 2021 +---------------------------------------- + +### **Summary** +This release is to direct logging output to the console rather than a physical file. + +Version 1.0.0, released Oct 9th 2020 +---------------------------------------- + +### **Summary** +his release marks the resolution of issues #19 and #27 as well as providing compatibility with the 1.2.0 release of jpo-ode. diff --git a/pom.xml b/pom.xml index 3fa6d4f..a1b03aa 100644 --- a/pom.xml +++ b/pom.xml @@ -15,7 +15,7 @@ junit junit - 4.12 + 4.13.1 test