You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/en/contributing.rst
+6-1
Original file line number
Diff line number
Diff line change
@@ -110,8 +110,10 @@ Testing
110
110
*******
111
111
112
112
Be sure you have tested the example in all the supported targets. If the example some specific hardware requirements,
113
-
edit/add the ``ci.json`` in the same folder as the sketch to specify the required configurations from ``sdkconfig``.
113
+
edit/add the ``ci.json`` in the same folder as the sketch to specify the regular expression for the
114
+
required configurations from ``sdkconfig``.
114
115
This will ensure that the CI system will run the test only on the targets that have the required configurations.
116
+
115
117
You can check the available configurations in the ``sdkconfig`` file in the ``tools/esp32-arduino-libs/<target>`` folder.
116
118
117
119
Here is an example of the ``ci.json`` file where the example requires Wi-Fi to work properly:
@@ -129,6 +131,9 @@ Here is an example of the ``ci.json`` file where the example requires Wi-Fi to w
129
131
The list of configurations will be checked against the ``sdkconfig`` file in the target folder. If the configuration is not present in the ``sdkconfig``,
130
132
the test will be skipped for that target. That means that the test will only run on the targets that have **ALL** the required configurations.
131
133
134
+
Also, by default, the "match start of line" character (``^``) will be added to the beginning of each configuration.
135
+
That means that the configuration must be at the beginning of the line in the ``sdkconfig`` file.
136
+
132
137
Sometimes, the example might not be supported by some target, even if the target has the required configurations
133
138
(like resources limitations or requiring a specific SoC). To avoid compilation errors, you can add the target to the ``ci.json``
134
139
file so the CI system will force to skip the test on that target.
0 commit comments