From 1c962ad0cf39f0b2cb4b002d6db8faae70aa0eb6 Mon Sep 17 00:00:00 2001 From: Alex Lisitsyn Date: Thu, 25 Jun 2026 14:13:14 +0100 Subject: [PATCH] fix: include mb_console_helper component to deploy stage --- .gitlab/ci/deploy.yml | 42 +++- components/mb_console_helper/LICENSE | 201 ++++++++++++++++++ .../mb_console_helper/idf_component.yml | 3 + tools/upload_component.sh | 96 +++++++++ 4 files changed, 336 insertions(+), 6 deletions(-) create mode 100644 components/mb_console_helper/LICENSE create mode 100644 tools/upload_component.sh diff --git a/.gitlab/ci/deploy.yml b/.gitlab/ci/deploy.yml index eff7180..501f2bb 100644 --- a/.gitlab/ci/deploy.yml +++ b/.gitlab/ci/deploy.yml @@ -4,12 +4,42 @@ upload_to_component_manager: tags: - deploy rules: - - if: '$CI_COMMIT_BRANCH == "main"' # the main branch is a component release branch for v2 - if: '$FORCE_PUSH_COMPONENT == "1"' when: manual allow_failure: true - script: - - pip install idf-component-manager - - export IDF_COMPONENT_API_TOKEN=${ESP_MODBUS_API_KEY} - - export COMP_VERSION=$(grep 'version:' idf_component.yml | head -n 1 | awk '{print $2}' | tr -d '"') - - compote component upload --namespace=espressif --name=esp-modbus --allow-existing --version=${COMP_VERSION} + - if: '$CI_COMMIT_BRANCH == "main"' # the main branch is a component release branch for v2 + - when: manual + allow_failure: true + script: | + set -eu + python -m pip install --upgrade idf-component-manager + + : "${IDF_COMPONENT_REGISTRY_URL:?IDF_COMPONENT_REGISTRY_URL is required for release}" + : "${ESP_MODBUS_API_KEY:?ESP_MODBUS_API_KEY is required for release}" + : "${ESP_MB_CONSOLE_HELPER_API_KEY:?ESP_MB_CONSOLE_HELPER_API_KEY is required for release}" + + get_component_version() { + awk '/^version:/ { gsub(/"/, "", $2); print $2; exit }' "$1/idf_component.yml" + } + + : > component_upload_status.env + : > component_upload_status.log + + # Publish dependencies first so dependent components can resolve them. + CONSOLE_HELPER_VERSION=$(get_component_version "${CI_PROJECT_DIR}/components/mb_console_helper") + sh "${CI_PROJECT_DIR}/tools/upload_component.sh" "mb_console_helper" "${CI_PROJECT_DIR}/components/mb_console_helper" "${CONSOLE_HELPER_VERSION}" "${ESP_MB_CONSOLE_HELPER_API_KEY}" + + COMP_VERSION=$(get_component_version "${CI_PROJECT_DIR}") + sh "${CI_PROJECT_DIR}/tools/upload_component.sh" "esp-modbus" "${CI_PROJECT_DIR}" "${COMP_VERSION}" "${ESP_MODBUS_API_KEY}" + + echo "Components released; esp-modbus ${COMP_VERSION}; mb_console_helper ${CONSOLE_HELPER_VERSION}" + cat component_upload_status.env + artifacts: + when: always + expire_in: 8 hrs + paths: + - component_upload_status.env + - component_upload_status.log + - ${CI_PROJECT_DIR}/**/dist/*.tgz + reports: + dotenv: component_upload_status.env diff --git a/components/mb_console_helper/LICENSE b/components/mb_console_helper/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/components/mb_console_helper/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/components/mb_console_helper/idf_component.yml b/components/mb_console_helper/idf_component.yml index f13fe32..75abd5a 100644 --- a/components/mb_console_helper/idf_component.yml +++ b/components/mb_console_helper/idf_component.yml @@ -1,3 +1,6 @@ +version: "0.0.1" +description: ESP-MODBUS console helper component for Modbus. +url: https://github.com/espressif/esp-modbus/tree/main/components/mb_console_helper dependencies: idf: version: ">=5.0" diff --git a/tools/upload_component.sh b/tools/upload_component.sh new file mode 100644 index 0000000..1a25357 --- /dev/null +++ b/tools/upload_component.sh @@ -0,0 +1,96 @@ +#!/bin/sh + +set -eu + +if [ "$#" -ne 4 ]; then + echo "Usage: $0 " + exit 1 +fi + +component_name="$1" +component_dir="$2" +component_version="$3" +component_token="$4" +component_env_key=$(printf '%s\n' "${component_name}" | tr '[:lower:]-' '[:upper:]_') +status_env_file="${COMPONENT_UPLOAD_STATUS_ENV:-component_upload_status.env}" +status_log_file="${COMPONENT_UPLOAD_STATUS_LOG:-component_upload_status.log}" + +extract_upload_job_id() { + sed -n 's/.*upload-status --job=\([0-9a-fA-F-]\{36\}\).*/\1/p' | tail -n 1 +} + +if [ ! -f "${component_dir}/idf_component.yml" ]; then + echo "Component manifest was not found: ${component_dir}/idf_component.yml" + exit 1 +fi + +if [ -z "${component_token}" ]; then + echo "API token for espressif/${component_name}:${component_version} is required" + exit 1 +fi + +echo "Uploading espressif/${component_name}:${component_version} from ${component_dir}" +export IDF_COMPONENT_API_TOKEN="${component_token}" + +set +e +upload_output=$( + cd "${component_dir}" && + compote component upload \ + --namespace=espressif \ + --name="${component_name}" \ + --allow-existing \ + --version="${component_version}" 2>&1 +) +upload_exit_code=$? +set -e + +printf '%s\n' "${upload_output}" +upload_job_id=$(printf '%s\n' "${upload_output}" | extract_upload_job_id) + +{ + echo "${component_env_key}_VERSION=${component_version}" + echo "${component_env_key}_UPLOAD_JOB_ID=${upload_job_id:-not_available}" +} >> "${status_env_file}" + +{ + echo "## espressif/${component_name}:${component_version}" + echo + echo "### upload" + printf '%s\n' "${upload_output}" + echo +} >> "${status_log_file}" + +if [ "${upload_exit_code}" -ne 0 ]; then + echo "Upload failed for espressif/${component_name}:${component_version}" + exit "${upload_exit_code}" +fi + +if [ -z "${upload_job_id}" ]; then + echo "No upload job ID was reported for espressif/${component_name}:${component_version}." + echo "${component_env_key}_UPLOAD_STATUS_EXIT_CODE=not_checked" >> "${status_env_file}" + { + echo "### upload-status" + echo "Not checked because the upload command did not report a job ID." + echo + } >> "${status_log_file}" + exit 0 +fi + +echo "Checking upload status for espressif/${component_name}:${component_version}; job ${upload_job_id}" +set +e +upload_status_output=$(compote component upload-status --job="${upload_job_id}" 2>&1) +upload_status_exit_code=$? +set -e + +printf '%s\n' "${upload_status_output}" +{ + echo "### upload-status" + printf '%s\n' "${upload_status_output}" + echo +} >> "${status_log_file}" +echo "${component_env_key}_UPLOAD_STATUS_EXIT_CODE=${upload_status_exit_code}" >> "${status_env_file}" + +if [ "${upload_status_exit_code}" -ne 0 ]; then + echo "Upload status check failed for espressif/${component_name}:${component_version}" + exit "${upload_status_exit_code}" +fi