docs(mosq): Prepare mosquitto component for publishing

espressif · Oct 11, 2024 · c2c4bf8 · c2c4bf8
1 parent 1af4bbe
commit c2c4bf8
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/publish-docs-component.yml b/.github/workflows/publish-docs-component.yml
@@ -100,5 +100,6 @@ jobs:
             components/console_cmd_wifi;
             components/esp_wifi_remote;
             components/mbedtls_cxx;
+            components/mosquitto;
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
diff --git a/README.md b/README.md
@@ -61,3 +61,8 @@ Please refer to instructions in [ESP-IDF](https://github.com/espressif/esp-idf)
 ### mbedtls_cxx
 
 * Brief introduction [README](components/mbedtls_cxx/README.md)
+
+### mosquitto
+
+* Brief introduction [README](components/mosquitto/README.md)
+* API documentation [api.md](components/mosquitto/api.md)
diff --git a/components/mosquitto/.cz.yaml b/components/mosquitto/.cz.yaml
@@ -1,6 +1,6 @@
 commitizen:
   bump_message: 'bump(mosq): $current_version -> $new_version'
-  pre_bump_hooks: python ../../ci/changelog.py mosq
+  pre_bump_hooks: python ../../ci/changelog.py mosquitto
   tag_format: mosq-v$version
   version: 2.0.27
   version_files: