From 5f48b2ef6471bcb0386eaf4f68300ccbf9f8bffa Mon Sep 17 00:00:00 2001 From: Ayush Sharma Date: Sat, 6 Jul 2024 22:57:05 +0530 Subject: [PATCH] fix: deprecation notice --- .github/scripts/dep-install.sh | 5 ---- .github/workflows/ci.yml | 44 ------------------------------ README.md | 13 +++------ examples/Async_Demo/Async_Demo.ino | 10 +++---- library.json | 4 +-- library.properties | 6 ++-- src/AsyncElegantOTA.h | 2 +- ui/README.md | 1 - 8 files changed, 15 insertions(+), 70 deletions(-) delete mode 100644 .github/scripts/dep-install.sh delete mode 100644 .github/workflows/ci.yml delete mode 100644 ui/README.md diff --git a/.github/scripts/dep-install.sh b/.github/scripts/dep-install.sh deleted file mode 100644 index fa1dd8e..0000000 --- a/.github/scripts/dep-install.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/bash -cd ${HOME}/Arduino/libraries -git clone https://github.com/me-no-dev/ESPAsyncWebServer.git ESPAsyncWebServer -git clone https://github.com/me-no-dev/ESPAsyncTCP.git ESPAsyncTCP -git clone https://github.com/me-no-dev/AsyncTCP.git AsyncTCP diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index 61d08ad..0000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Arduino Library CI - -on: - push: - paths-ignore: - - '**/**.md' - - '/keywords.txt' - - '/library.json' - - '/library.properties' - - '/ui' - - '/docs' - pull_request: - paths-ignore: - - '**/**.md' - - '/keywords.txt' - - '/library.json' - - '/library.properties' - - '/ui' - - '/docs' - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/setup-python@v1 - with: - python-version: '3.x' - - - uses: actions/checkout@v2 - - - uses: actions/checkout@v2 - with: - repository: adafruit/ci-arduino - path: ci - - - name: pre-install - run: bash ci/actions_install.sh - - - name: install-deps - run: bash .github/scripts/dep-install.sh - - - name: test platforms - run: python3 ci/build_platform.py esp8266 esp32 diff --git a/README.md b/README.md index 25df5e0..3ab3885 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,7 @@ -

+# (Deprecated) AsyncElegantOTA - -

Deprecated

+AsyncElegantOTA has been **deprecated** and it is NOT recommended for usage. Please consider migrating to **[ElegantOTA](https://github.com/ayushsharma82/ElegantOTA) which now comes with async mode**. Learn More on async mode: https://docs.elegantota.pro/async-mode/ -

-AsyncElegantOTA has been deprecated in favor of new ElegantOTA V3 which now comes with Async Mode and latest features. Please consider moving to ElegantOTA V3 for further updates and improvements. Learn More -

+--- -

-Existing users/supporters, please star the latest ElegantOTA repository so that more people can know about it :) Thanks! -

+**ElegantOTA** is the latest library that is much more reliable and has an advanced upload mechanism. diff --git a/examples/Async_Demo/Async_Demo.ino b/examples/Async_Demo/Async_Demo.ino index e854695..04b8504 100644 --- a/examples/Async_Demo/Async_Demo.ino +++ b/examples/Async_Demo/Async_Demo.ino @@ -1,10 +1,10 @@ /* - AsyncElegantOTA Demo Example - This example will work for both ESP8266 & ESP32 microcontrollers. + (Deprecated) AsyncElegantOTA Demo Example ----- - Author: Ayush Sharma ( https://github.com/ayushsharma82 ) - - Important Notice: Star the repository on Github if you like the library! :) - Repository Link: https://github.com/ayushsharma82/AsyncElegantOTA + + This library has been deprecated. Please migrate to ElegantOTA v3 + New Repo: https://github.com/ayushsharma82/ElegantOTA + Async Mode: https://docs.elegantota.pro/async-mode/ */ #if defined(ESP8266) diff --git a/library.json b/library.json index 7494f26..dd70f25 100644 --- a/library.json +++ b/library.json @@ -1,7 +1,7 @@ { "name": "AsyncElegantOTA", "keywords": "AsyncElegantOTA, OTA, Update, ESP8266, ESP32, Over, the, air", - "description": "Perform OTAs for ESP8266 & ESP32 Asynchronously.", + "description": "(Deprecated) Migrate to ElegantOTA v3. More info in repository README.", "repository": { "type": "git", @@ -15,7 +15,7 @@ "maintainer": true } ], - "version": "2.2.8", + "version": "2.2.9", "frameworks": "arduino", "platforms": ["espressif8266", "espressif32"] } diff --git a/library.properties b/library.properties index 4e93439..9236b7e 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ name=AsyncElegantOTA -version=2.2.8 +version=2.2.9 author=Ayush Sharma category=Communication maintainer=Ayush Sharma -sentence=Perform OTAs for ESP8266 & ESP32 Asynchronously. -paragraph=A User Interface Library which provides interactive elements for your Over the Air Updates on ESP8266/ESP32. +sentence=Deprecated: Migrate to EleganOTA v3. More info in repository README. +paragraph=Deprecated: Migrate to ElegantOTA v3. More info in repository README. url=https://github.com/ayushsharma82/AsyncElegantOTA architectures=esp8266,esp32 diff --git a/src/AsyncElegantOTA.h b/src/AsyncElegantOTA.h index afae3f9..b87e3ad 100644 --- a/src/AsyncElegantOTA.h +++ b/src/AsyncElegantOTA.h @@ -1,7 +1,7 @@ #ifndef AsyncElegantOTA_h #define AsyncElegantOTA_h -#warning AsyncElegantOTA library is deprecated, Please consider moving to newer ElegantOTA library which now comes with an Async Mode. Learn More: https://docs.elegantota.pro/async-mode/ +#error AsyncElegantOTA library is deprecated, Please consider migrating to newer ElegantOTA library which now comes with an async mode. Learn More: https://docs.elegantota.pro/async-mode/ #include "Arduino.h" #include "stdlib_noniso.h" diff --git a/ui/README.md b/ui/README.md deleted file mode 100644 index e5ee20a..0000000 --- a/ui/README.md +++ /dev/null @@ -1 +0,0 @@ -Find source code of user interface in original ElegantOTA repository. [Click Here](https://github.com/ayushsharma82/ElegantOTA/tree/master/ui). \ No newline at end of file