make the main branch as an component release branch

This commit is contained in:
aleks
2024-12-18 11:31:13 +01:00
parent adbfa28e59
commit 65322a7a3c
3 changed files with 10 additions and 7 deletions

View File

@ -296,8 +296,10 @@ build_docs:
- source ${CI_PROJECT_DIR}/docs/utils.sh
- add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
- export GIT_VER=$(git describe --always)
- export GIT_TAGS=$(git fetch --tags; git tag -l;)
- echo "Deploy ${PWD##*/}, ${DOCS_BUILD_DIR}, Ref name; ${CI_COMMIT_REF_NAME}"
- echo "Version; ${GIT_VER}, tags; ${GIT_TAGS}"
- pip install -r ${CI_PROJECT_DIR}/docs/requirements.txt
- export CI_COMMIT_REF_NAME="v2.0.0-beta" # override the reference name
- deploy-docs
deploy_docs_preview:
@ -305,7 +307,7 @@ deploy_docs_preview:
- .deploy_docs_template
except:
refs:
- master
- main
variables:
TYPE: "preview"
DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
@ -320,7 +322,7 @@ deploy_docs_production:
- .deploy_docs_template
only:
refs:
- master
- main
variables:
TYPE: "production"
DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
@ -336,8 +338,9 @@ upload_to_component_manager:
tags:
- deploy
rules:
- if: '$CI_COMMIT_BRANCH == "release/v2.0"'
- if: '$CI_COMMIT_BRANCH == "main"' # the main branch is a component release branch for v2
- if: '$FORCE_PUSH_COMPONENT == "1"'
when: manual
script:
- pip install idf-component-manager
- export IDF_COMPONENT_API_TOKEN=${ESP_MODBUS_API_KEY}

View File

@ -22,7 +22,7 @@ ESP-IDF v5.x and later releases do not include freemodbus component, so no extra
## Peculiarities Of Current Release
The current release esp-modbus corresponds to the version `v2.0.0` and supports creation of several instances of modbus master and slave objects. The public API interface is changed to allow creation of multiple communication objects with its own communication parameters, and the constructor API returns the handle to the interface structure that must be used as a first parameter for each API call for this particular object. For more information about the interface API and related changes see the official documentation for this release, described below. The goal of this beta release is to introduce new features and changes to the end users and get their feedback. The appropriate information or feature requests can be shared over on discussion page of the project.
The current release esp-modbus corresponds to the version `v2.x.x` (refer to idf_component.yml file) and supports creation of several instances of modbus master and slave objects. The public API interface is changed to allow creation of multiple communication objects with its own communication parameters, and the constructor API returns the handle to the interface structure that must be used as a first parameter for each API call for this particular object. For more information about the interface API and related changes see the official documentation for this release, described below. The goal of this beta release is to introduce new features and changes to the end users and get their feedback. The appropriate information or feature requests can be shared over on discussion page of the project.
* [Discussions](https://github.com/espressif/esp-modbus/discussions/categories/general)
* [Issues](https://github.com/espressif/esp-modbus/issues)
@ -31,7 +31,7 @@ The current release esp-modbus corresponds to the version `v2.0.0` and supports
The documentation can be found on the link below:
* [ESP-Modbus documentation (English)](https://docs.espressif.com/projects/esp-modbus/en/v2.0.0/esp32/index.html)
* [ESP-Modbus documentation (English)](https://docs.espressif.com/projects/esp-modbus/en/stable/esp32/index.html)
## Application Examples

View File

@ -1,4 +1,4 @@
version: "2.0.0~1"
version: "2.0.1"
description: ESP-MODBUS is the official Modbus library for Espressif SoCs.
url: https://github.com/espressif/esp-modbus
dependencies: