df75f38a5c
* Workflow final + docs added Delete LIBRARY_TEST.md Update readme + documentation Generated External Libraries Test Results Updated docs Generated External Libraries Test Results revert last commit DOnt install arduino-core manually Update external_libraries_test.rst Generated External Libraries Test Results Align FQBNs to platform name use manula platform installation Generated External Libraries Test Results remove verbose remove - before sketch path Add libs and examples for specific chip Generated External Libraries Test Results Generated External Libraries Test Results Update README.md Generated External Libraries Test Results Update README.md Update README.md Generated External Libraries Test Results change name of GH action replace - for / Generated External Libraries Test Results Generated External Libraries Test Results Update lib.yml Update lib.yml Generated External Libraries Test Results remove types from pull_rewuest add pull to lib.yml Generated External Libraries Test Results add back deltas_report Update LIBRARY_TEST.md add verbose logs remove deltas report Generated External Libraries Test Results Change from schedule to push for testing add P-R-O-C-H-Y repo to cron job rename workflow Update LIBRARY_TEST.md Update LIBRARY_TEST.md Edit URL Generated External Libraries Test Results remove unused ymls + run job on schedule generated Add action link push only result file generated fix names fix workflow run workflow on push Add report to file action remove separator fix example paths fix library name yaml list of examples edit update universal sketches examples path fix update example paths Add ESP32Servo warnings -> all change warnings to "default" fix library name fix list add matrix to compile sketches test compile for only 1 chip remove GPIO example use edited action Add Blynk library use v1 print arduino cli version fix listing update libs list fix remove if fix typo fix path path test list fix fix folder creating add install IDE list fix fix missing run command Added V3 lib test + script for lib install fix typo add platform updated on: Lib testing v2 fix fqbn test all chips typo fix replace blynk with Adafruit Neopixel change blynk example fix yml format add action name Add report for PR Enable warnings report changed position typo test remove dbg level add log level option split command typo typo add empty space change position of cli flags fix typo cli compile flags not marking warning as error Add new lib+example install core manually Install core by compile-sketch fix url->path fix typo Install core from repo remove external lib checkout add lib example update board change platform name change platform name use BoardManager update example update example use repo as platform Initial commit Update README.md Update README.md * fix readme links * added JSON + lib_v2 YAML * Update lib_v2.yml * Update lib_v2.yml * Update lib_v2.yml * Update lib_v2.yml * Update lib_v2.yml * Update lib_v2.yml * Update lib_v2.yml * update JSON file * Added json file * Update lib.yml * Update lib_v2.yml * Update lib_v2.yml * change JSON * edit json + add version * edit json * update version * fix path * update fqbn platform name * add empty test result file * Add latest changes * Update docs * Update docs + clean YAML fifle * Add ESPAsyncWebServer library * Add test multiple required libs (will revert) * Update docs + json * Update lib.yml * Fix typos in docs * fix readme links
132 lines
No EOL
4.5 KiB
ReStructuredText
132 lines
No EOL
4.5 KiB
ReStructuredText
##########################
|
|
External Libraries Testing
|
|
##########################
|
|
|
|
About
|
|
-----
|
|
|
|
External libraries testing is a compilation test for listed libraries on arduino-esp32 master branch. The test was made for users, so they can check which libraries are compiling without errors on which SoC.
|
|
External libraries test is running periodically (once a week) against master branch and can also run on PR by adding a label ``lib_test``.
|
|
The test is running on all supported ESP32 chips.
|
|
|
|
.. note::
|
|
As the test is just a compilation of example, that does not guarantee that the library/sketch will run without any problems after flashing it on your device.
|
|
|
|
How to Add Library to Test
|
|
--------------------------
|
|
|
|
To add a library to the CI test you need to add your library to the `lib.json`_. file located in ``./github/workflows/``.
|
|
|
|
.. note::
|
|
Please add the libraries to the `lib.json`_ in alphabetical order, thanks.
|
|
|
|
List of parameters:
|
|
*******************
|
|
|
|
Where the library will be installed from (use only 1 option):
|
|
|
|
* ``name`` - Name of the Library in Arduino Library Manager.
|
|
* ``source-url`` - URL to the library github repository (example: "https://github.com/Arduino-IRremote/Arduino-IRremote.git"). Use when your Library is not listed in Arduino Library Manager.
|
|
|
|
Required:
|
|
|
|
* ``exclude_targets`` - List of targets to be excluded from testing. Use only when the SoC dont support used peripheral.
|
|
* ``sketch_path`` - Path / paths to the sketch / sketches to be tested.
|
|
|
|
Optional:
|
|
|
|
* ``version`` - Version of the library.
|
|
* ``required-libs`` - Libraries that are necessary to be installed to compile the tested library.
|
|
* ``destination-name`` - Folder name used for the installation of library (use only when needed).
|
|
|
|
|
|
Example of library addition from Arduino Library Manager with ESP32-S2 excluded:
|
|
********************************************************************************
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"name": "ArduinoBLE",
|
|
"exclude_targets": [
|
|
"esp32s2"
|
|
],
|
|
"sketch_path": [
|
|
"~/Arduino/libraries/ArduinoBLE/examples/Central/Scan/Scan.ino"
|
|
]
|
|
}
|
|
|
|
Example of library addition from Github URL with required library:
|
|
******************************************************************
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"source-url": "https://github.com/me-no-dev/ESPAsyncWebServer.git",
|
|
"required-libs": [
|
|
{"source-url": "https://github.com/me-no-dev/AsyncTCP.git"}
|
|
],
|
|
"exclude_targets": [],
|
|
"sketch_path": [
|
|
"~/Arduino/libraries/ESPAsyncWebServer/examples/CaptivePortal/CaptivePortal.ino",
|
|
"~/Arduino/libraries/ESPAsyncWebServer/examples/ESP_AsyncFSBrowser/ESP_AsyncFSBrowser.ino",
|
|
"~/Arduino/libraries/ESPAsyncWebServer/examples/regex_patterns/regex_patterns.ino",
|
|
"~/Arduino/libraries/ESPAsyncWebServer/examples/simple_server/simple_server.ino"
|
|
]
|
|
},
|
|
|
|
Submit a PR
|
|
***********
|
|
|
|
* Open a PR with the changes and someone from Espressif team will add a label ``lib_test`` to the PR and CI will run the test to check, if the addition is fine and the library/example is compiling.
|
|
|
|
* After merging your PR, the next scheduled test will test your library and add the results to the `LIBRARIES_TEST.md`_.
|
|
|
|
Test Results
|
|
------------
|
|
|
|
Icons meaning
|
|
*************
|
|
|
|
There is a number before each icon, which means the number of examples which were compiled with that result.
|
|
|
|
* |success| - Compilation was successful.
|
|
|
|
* |warning| - Compilation was successful, but some warnings occurs.
|
|
|
|
* |fail| - Compilation failed.
|
|
|
|
* ``N/A`` - Not tested (target is in exclude_targets list).
|
|
|
|
Scheduled test result
|
|
*********************
|
|
|
|
You can check the results in `LIBRARIES_TEST.md`_.
|
|
|
|
The results file example:
|
|
|
|
.. image:: _static/external_library_test_schedule.png
|
|
:width: 600
|
|
|
|
Pull Request test result
|
|
************************
|
|
|
|
If the test run on Pull Request, it will compile all libraries and sketches 2 times (before/after changes in PR) to see, if the PR is breaking/fixing libraries.
|
|
In the table the results are in order ``BEFORE -> AFTER``.
|
|
|
|
.. image:: _static/external_library_test_pr.png
|
|
:width: 600
|
|
|
|
.. |success| image:: _static/green_checkmark.png
|
|
:height: 2ex
|
|
:class: no-scaled-link
|
|
|
|
.. |warning| image:: _static/warning.png
|
|
:height: 2ex
|
|
:class: no-scaled-link
|
|
|
|
.. |fail| image:: _static/cross.png
|
|
:height: 2ex
|
|
:class: no-scaled-link
|
|
|
|
.. _LIBRARIES_TEST.md: https://github.com/espressif/arduino-esp32/LIBRARIES_TEST.md
|
|
.. _lib.json: https://github.com/espressif/arduino-esp32/.github/workflow/lib.json |