idf_build_apps 2.2.0__tar.gz → 2.2.2__tar.gz

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/.github/workflows/test-build-docs.yml

@@ -20,3 +20,5 @@ jobs:
       - name: Build the docs
         run: |
           cd docs && make html
+      - name: markdown-link-check
+        uses: gaurav-nelson/github-action-markdown-link-check@1.0.15

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## v2.2.2 (2024-03-13)
+
+### Fix
+
+- skip size json generation for targets in preview
+
+## v2.2.1 (2024-03-04)
+
+### Fix
+
+- override sdkconfig item keep possible double quotes
+
 ## v2.2.0 (2024-02-22)
 
 ### Feat

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: idf-build-apps
-Version: 2.2.0
+Version: 2.2.2
 Summary: Tools for building ESP-IDF related apps.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=3.7
@@ -110,5 +110,5 @@ Thanks for your contribution! Please refer to our [Contributing Guide](CONTRIBUT
 [hello-world]: https://github.com/espressif/esp-idf/tree/master/examples/get-started/hello_world
 [supported-targets]: https://github.com/espressif/esp-idf/tree/v5.0#esp-idf-release-and-soc-compatibility
 [doc]: https://docs.espressif.com/projects/idf-build-apps/en/latest/
-[api-doc]: https://docs.espressif.com/projects/idf-build-apps/en/latest/api.html
+[api-doc]: https://docs.espressif.com/projects/idf-build-apps/en/latest/api/modules.html
 

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/README.md

@@ -73,4 +73,4 @@ Thanks for your contribution! Please refer to our [Contributing Guide](CONTRIBUT
 [hello-world]: https://github.com/espressif/esp-idf/tree/master/examples/get-started/hello_world
 [supported-targets]: https://github.com/espressif/esp-idf/tree/v5.0#esp-idf-release-and-soc-compatibility
 [doc]: https://docs.espressif.com/projects/idf-build-apps/en/latest/
-[api-doc]: https://docs.espressif.com/projects/idf-build-apps/en/latest/api.html
+[api-doc]: https://docs.espressif.com/projects/idf-build-apps/en/latest/api/modules.html

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/docs/manifest.md

@@ -177,11 +177,13 @@ Low-level dependencies, are components or files that are used by many others. Fo
 
 To disable the build-apps-only-on-related-changes feature, you can use the CLI option `--ignore-app-dependencies-filepatterns`. Once any of the modified files matches the specified patterns, the special rules will be disabled. All apps will be built, no exceptions.
 
-## `switch` Clauses
+## Enhanced YAML Syntax
 
-The `switch` clauses are supported by two keywords in the YAML file: `depends_components` and `depends_filepatterns`.
+### Switch-Like Clauses
 
-### Operands
+The Switch-Like clauses are supported by two keywords in the YAML file: `depends_components` and `depends_filepatterns`.
+
+#### Operands
 
 Switch cases have two main components: the `if` clause and the `default` clause. Just like a switch statement in c language, The first matched `if` clause will be applied. If no `if` clause matched, the `default` clause will be applied. Here's an example:
 
@@ -197,12 +199,10 @@ test1:
 
 `default` clause is optional. If you don't specify any `default` clause, it will return an empty array.
 
-### Limitations
+#### Limitations
 
 You cannot combine a list and a switch in one node.
 
-## Enhanced YAML Syntax
-
 ### Reuse Lists
 
 To reuse the items defined in a list, you can use the `+` and `-` postfixes respectively. The order of calculation is always `+` first, followed by `-`.

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/idf_build_apps/__init__.py

@@ -8,7 +8,7 @@ Tools for building ESP-IDF related apps.
 # ruff: noqa: E402
 # avoid circular imports
 
-__version__ = '2.2.0'
+__version__ = '2.2.2'
 
 from .session_args import (
     SessionArgs,

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/idf_build_apps/app.py

@@ -39,6 +39,7 @@ from .constants import (
     IDF_VERSION_MAJOR,
     IDF_VERSION_MINOR,
     IDF_VERSION_PATCH,
+    PREVIEW_TARGETS,
     PROJECT_DESCRIPTION_JSON,
     BuildStage,
     BuildStatus,
@@ -666,6 +667,11 @@ class App(BaseModel):
         self._logger.debug('Generated size info to %s', self.size_json_path)
 
     def write_size_json(self) -> None:
+        if self.target in PREVIEW_TARGETS:
+            # targets in preview may not yet have support in esp-idf-size
+            self._logger.info('Skipping generation of size json for target %s as it is in preview.', self.target)
+            return
+
         try:
             self._write_size_json()
         except Exception as e:

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/idf_build_apps/session_args.py

@@ -51,7 +51,7 @@ class SessionArgs:
 
             with open(f) as fr:
                 for line in fr:
-                    m = re.compile(r'^([^=]+)=\"?([^\"\n]*)\"?\n*$').match(line)
+                    m = re.compile(r'^([^=]+)=([^\n]*)\n*$').match(line)
                     if not m:
                         continue
                     d[m.group(1)] = m.group(2)
@@ -60,7 +60,7 @@ class SessionArgs:
     def _get_override_sdkconfig_items(self, override_sdkconfig_items: t.Tuple[str]) -> t.Dict:
         d = {}
         for line in override_sdkconfig_items:
-            m = re.compile(r'^([^=]+)=\"?([^\"\n]*)\"?\n*$').match(line)
+            m = re.compile(r'^([^=]+)=([^\n]*)\n*$').match(line)
             if m:
                 d[m.group(1)] = m.group(2)
         return d

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/pyproject.toml

@@ -60,7 +60,7 @@ idf-build-apps = "idf_build_apps:main.main"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "2.2.0"
+version = "2.2.2"
 tag_format = "v$version"
 version_files = [
     "idf_build_apps/__init__.py",

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/setup.py

@@ -30,7 +30,7 @@ entry_points = \
 {'console_scripts': ['idf-build-apps = idf_build_apps:main.main']}
 
 setup(name='idf-build-apps',
-      version='2.2.0',
+      version='2.2.2',
       description='Tools for building ESP-IDF related apps.',
       author=None,
       author_email='Fu Hanxi <fuhanxi@espressif.com>',

{idf_build_apps-2.2.0 → idf_build_apps-2.2.2}/tests/test_finder.py

@@ -494,14 +494,15 @@ CONFIG_FREERTOS_IDLE_TASK_STACKSIZE=1516
 
         Args = namedtuple('Args', ['override_sdkconfig_items', 'override_sdkconfig_files'])
         args = Args(
-            'CONFIG_IDF_TARGET=esp32c3,CONFIG_FREERTOS_IDLE_TASK_STACKSIZE=1522,CONFIG_A=10', 'sdkconfig.override1'
+            'CONFIG_IDF_TARGET=esp32c3,CONFIG_FREERTOS_IDLE_TASK_STACKSIZE=1522,CONFIG_A=10,CONFIG_C="test"',
+            'sdkconfig.override1',
         )
         idf_build_apps.SESSION_ARGS.set(args, workdir=tmp_path)
         session_args = idf_build_apps.SESSION_ARGS
 
         assert str(tmp_path) in str(session_args.override_sdkconfig_file_path)
-        assert len(session_args.override_sdkconfig_items) == 4
-        assert len(set(session_args.override_sdkconfig_items)) == 4
+        assert len(session_args.override_sdkconfig_items) == 5
+        assert len(set(session_args.override_sdkconfig_items)) == 5
 
         apps = find_apps(str(tmp_path / 'test1'), 'esp32s2')
         assert len(apps) == 0
@@ -514,13 +515,14 @@ CONFIG_FREERTOS_IDLE_TASK_STACKSIZE=1516
 
         with open(apps[0].sdkconfig_files[-1]) as fr:
             lines = fr.readlines()
-            assert len(lines) == 4
+            assert len(lines) == 5
             for _l in lines:
                 assert _l in [
                     'CONFIG_IDF_TARGET=esp32c3\n',
                     'CONFIG_A=10\n',
                     'CONFIG_FREERTOS_IDLE_TASK_STACKSIZE=1522\n',
                     'CONFIG_B=33\n',
+                    'CONFIG_C="test"\n',
                 ]
 
     def test_config_name_in_manifest(self, tmp_path):