From 8e1fa73dd353778351e17740bf6fac3819842c73 Mon Sep 17 00:00:00 2001 From: Christian Rowlands Date: Wed, 20 Dec 2023 10:39:23 -0500 Subject: [PATCH] Move the release notes to a changelog file --- CHANGELOG.md | 43 +++++++++++++++++++++++++++++++++++++++++++ README.md | 40 ++-------------------------------------- 2 files changed, 45 insertions(+), 38 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..70936a5 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,43 @@ +# Changelog + +## [0.7.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.7.0) - 2023-12-20 +* Add support for setting a topic prefix for the MQTT topics that this library publishes to. + +## [0.6.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.6.0) - 2023-07-17 +* Overload the publishMessage method to enable sending plain JSON strings. + +## [0.5.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.5.0) - 2022-10-25 +* Change the onMdmOverride method to protected so it can be overridden + +## [0.4.5](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.5) - 2022-06-16 +* Made MQTT connection fields protected so they can be manipulated from deriving classes. +* Updated some dependencies. + +## [0.4.4](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.4) - 2022-06-11 +* Added some defensive programming around the service being null when the mdm override switch is toggled. +* Updated several of the libraries. + +## [0.4.3](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.3) - 2021-07-10 +* Added some defensive programming when updating the UI state if the fragment has been detached. + +## [0.4.2](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.2) - 2021-06-28 +* Fixed a bug where the MQTT connection would not reestablish when the Internet connection dropped. + +## [0.4.1](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.1) - 2021-06-11 +* Fixed a bug where a UI deadlock could occur when the connection is unsuccessful and messages are published. +* Improved UX for showing the user connection error reasons such as invalid username and password. + +## [0.4.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.0) - 2021-06-10 +* Added support for queueing messages while the MQTT broker connection is offline and resending them when a connection comes back online. + +## [0.3.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.3.0) - 2021-06-03 +* Changed the QoS from 0 to 1 for the MQTT connection. + +## [0.2.1](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.2.1) - 2021-04-30 +* Added some additional protections against concurrent MQTT connections. + +## [0.2.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.2.0) - 2021-04-28 +* Switched out the Eclipse Paho MQTT Client for HiveMQ to improve stability and error scenario handling. + +## [0.1.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.1.0) - 2020-12-22 +* Initial release of this Android MQTT Connection Library. diff --git a/README.md b/README.md index b77e568..ece618f 100644 --- a/README.md +++ b/README.md @@ -24,45 +24,9 @@ It is important to note that the pieces provided in the library cannot stand on - Execute `gradlew publishReleasePublicationToMavenLocal` in the root directory to publish the release aar artifact to the local Maven cache. -## Change log -##### [0.6.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.6.0) - 2023-07-17 -* Overload the publishMessage method to enable sending plain JSON strings. +## Changelog -##### [0.5.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.5.0) - 2022-10-25 -* Change the onMdmOverride method to protected so it can be overridden - -##### [0.4.5](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.5) - 2022-06-16 - * Made MQTT connection fields protected so they can be manipulated from deriving classes. - * Updated some dependencies. - -##### [0.4.4](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.4) - 2022-06-11 - * Added some defensive programming around the service being null when the mdm override switch is toggled. - * Updated several of the libraries. - -##### [0.4.3](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.3) - 2021-07-10 - * Added some defensive programming when updating the UI state if the fragment has been detached. - -##### [0.4.2](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.2) - 2021-06-28 - * Fixed a bug where the MQTT connection would not reestablish when the Internet connection dropped. - -##### [0.4.1](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.1) - 2021-06-11 - * Fixed a bug where a UI deadlock could occur when the connection is unsuccessful and messages are published. - * Improved UX for showing the user connection error reasons such as invalid username and password. - -##### [0.4.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.0) - 2021-06-10 - * Added support for queueing messages while the MQTT broker connection is offline and resending them when a connection comes back online. - -##### [0.3.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.3.0) - 2021-06-03 - * Changed the QoS from 0 to 1 for the MQTT connection. - -##### [0.2.1](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.2.1) - 2021-04-30 - * Added some additional protections against concurrent MQTT connections. - -##### [0.2.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.2.0) - 2021-04-28 - * Switched out the Eclipse Paho MQTT Client for HiveMQ to improve stability and error scenario handling. - -##### [0.1.0](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.1.0) - 2020-12-22 - * Initial release of this Android MQTT Connection Library. +See the change log for details about each release: [`CHANGELOG.md`](CHANGELOG.md) ## Contact * **Eliza Alcaraz** - [eliza-mae-alcaraz](https://github.com/eliza-mae-alcaraz)