Merge branch 'feat/add_script_bump_new_version' into 'main'

ydhub · ydhub · commit 7a5ddbcad0e8 · 2024-03-21T10:57:34.000+08:00
ci: update publish components flow Closes #1 See merge request qa/idf-components/iperf-cmd!7
diff --git a/.cz.toml b/.cz.toml
@@ -0,0 +1,19 @@
+[tool.commitizen]
+version = "0.1.1"
+name = "cz_conventional_commits"
+version_files = [
+    "apps/iperf/main/idf_component.yml",
+    "iperf/idf_component.yml",
+    "iperf/CHANGELOG.md",
+    "iperf/README.md",
+    "iperf-cmd/idf_component.yml",
+    "iperf-cmd/CHANGELOG.md",
+    "iperf-cmd/README.md",
+]
+tag_format = "v$major.$minor.$patch"
+version_scheme = "semver"
+bump_message = "bump: development version $current_version → $new_version"
+update_changelog_on_bump = false
+pre_bump_hooks = [
+  "tools/pre_bump_hook.sh"
+]
diff --git a/.github/workflows/publish_components.yml b/.github/workflows/publish_components.yml
@@ -0,0 +1,36 @@
+name: Publish iperf/iperf-cmd to IDF Component Registry
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  upload_components:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v5
+
+      - name: check components version same with tag
+        run: |
+          pip install -r tools/requirements.txt
+          python tools/check_version.py --version ${{ github.ref_name }}
+
+      - name: Upload iperf to IDF Component Registry
+        uses: espressif/upload-components-ci-action@v1
+        with:
+          name: "iperf"
+          directories: "iperf"
+          version: ${{ github.ref_name }}
+          namespace: "espressif"
+          api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
+
+      - name: Upload iperf_cmd to IDF Component Registry
+        uses: espressif/upload-components-ci-action@v1
+        with:
+          name: "iperf-cmd"
+          directories: "iperf-cmd"
+          version: ${{ github.ref_name }}
+          namespace: "espressif"
+          api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -71,3 +71,37 @@ build_iperf_v43:
   tags:
     - build
     - internet
+
+publish_components:
+  stage: publish
+  image: ${GITLAB_DOCKER_REGISTRY}/qa/dockerfiles/qa-python-env:2
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v\d+\.\d+(\.\d+)?($|-)/'
+  needs:
+    - job: build_iperf
+      artifacts: false
+    - job: build_iperf_v43
+      artifacts: false
+  before_script:
+    - pip3 install Commitizen
+    - cz version -v
+    - git config user.name "${GITLAB_USER_LOGIN}"
+    - git config user.email "${GITLAB_USER_EMAIL}"
+  script:
+    - python tools/check_version.py --version ${CI_COMMIT_TAG}
+    # push to github and publish components
+    - gitlab project-protected-tag create --name ${CI_COMMIT_TAG} --project-id=${CI_PROJECT_ID} --private-token ${GITLAB_PRIVATE_TOKEN}
+    # bump new version: default PATCH
+    - git branch -D bump/new_patch_version || true
+    - git checkout -b bump/new_patch_version
+    - cz bump --increment=PATCH
+    # Do not add tag for new version
+    - git tag --delete v$(cz version --project) || true
+    - |
+      git push -f \
+        -o merge_request.create \
+        -o merge_request.title="bump: ${CI_COMMIT_TAG} -> next patch version" \
+        -o merge_request.assign="${GITLAB_USER_LOGIN}" \
+        origin bump/new_patch_version
+  tags:
+    - host_test
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -25,6 +25,7 @@ repos:
     hooks:
       - id: pylint                                       # Runs pylint on Python code
         additional_dependencies: ['PyYAML']
+        args: ['--max-line-length=120']
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.2.1
diff --git a/apps/iperf/main/idf_component.yml b/apps/iperf/main/idf_component.yml
@@ -1,8 +1,8 @@
 ## IDF Component Manager Manifest File
 dependencies:
   espressif/iperf:
-    version: "0.0.1"
-    override_path: "../../../iperf"
+    version: =0.1.1
+    override_path: ../../../iperf
   espressif/iperf-cmd:
-    version: "0.0.1"
-    override_path: "../../../iperf-cmd"
+    version: =0.1.1
+    override_path: ../../../iperf-cmd
diff --git a/iperf-cmd/CHANGELOG.md b/iperf-cmd/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## [0.0.1](https://github.com/espressif/iperf-cmd/commits/v0.0.1)
+## [0.1.1](https://github.com/espressif/iperf-cmd/commits/v0.1.1)
 
 ### Features
 
diff --git a/iperf-cmd/README.md b/iperf-cmd/README.md
@@ -31,6 +31,6 @@ This repository contains `iperf` command based esp-idf console.
   ```yaml
   dependencies:
     espressif/iperf_cmd:
-      version: "^0.0.1"
+      version: "^0.1.1"
   ```
 - For more details refer [IDF Component Manager](https://docs.espressif.com/projects/idf-component-manager/en/latest/)
diff --git a/iperf-cmd/idf_component.yml b/iperf-cmd/idf_component.yml
@@ -1,17 +1,17 @@
-version: "0.0.1"
+version: 0.1.1
 description: Iperf command based on esp-idf console
 url: https://github.com/espressif/iperf-cmd/tree/master/iperf-cmd
 repository: https://github.com/espressif/iperf-cmd.git
 documentation: https://iperf.fr/iperf-doc.php
 issues: https://github.com/espressif/iperf-cmd/issues
 license: Apache-2.0
 dependencies:
-  idf: ">=4.3"
+  idf: '>=4.3'
   espressif/iperf:
-    version: "0.0.1"
+    version: =0.1.1
 examples:
   - path: ../apps/iperf/
 files:
   exclude:
-    - "doxygen/**/*"
-    - "doxygen"
+    - doxygen/**/*
+    - doxygen
diff --git a/iperf/CHANGELOG.md b/iperf/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## [0.0.1](https://github.com/espressif/iperf-cmd/commits/v0.0.1)
+## [0.1.1](https://github.com/espressif/iperf-cmd/commits/v0.1.1)
 
 ### Features
 
diff --git a/iperf/README.md b/iperf/README.md
@@ -16,6 +16,6 @@ This repository contains a basic iperf core engine.
   ```yaml
   dependencies:
     espressif/iperf:
-      version: "^0.0.1"
+      version: "^0.1.1"
   ```
 - For more details refer [IDF Component Manager](https://docs.espressif.com/projects/idf-component-manager/en/latest/)
diff --git a/iperf/idf_component.yml b/iperf/idf_component.yml
@@ -1,13 +1,13 @@
-version: "0.0.1"
+version: 0.1.1
 description: Iperf Core Engine
 url: https://github.com/espressif/iperf-cmd/tree/master/iperf
 repository: https://github.com/espressif/iperf-cmd.git
 documentation: https://iperf.fr/iperf-doc.php
 issues: https://github.com/espressif/iperf-cmd/issues
 license: Apache-2.0
 dependencies:
-  idf: ">=4.3"
+  idf: '>=4.3'
 files:
   exclude:
-    - "doxygen/**/*"
-    - "doxygen"
+    - doxygen/**/*
+    - doxygen
diff --git a/tools/check_version.py b/tools/check_version.py
@@ -15,6 +15,8 @@
 
 def check_version(version: str):
     """Check iperf and iperf-cmd versions"""
+    if version.startswith('v'):
+        version = version[1:]
     for component_yml in COMPONENT_YML_FILES:
         with open(component_yml, 'r', encoding='utf-8') as f:
             data = yaml.load(f, Loader=yaml.SafeLoader)
@@ -28,9 +30,7 @@ def check_version(version: str):
         dependencies = data['dependencies']
         for key, val in dependencies.items():
             if key in ['espressif/iperf', 'espressif/iperf-cmd']:
-                assert (
-                    version == val['version']
-                ), f'dependencies version mismatch: {component_yml}'
+                assert val['version'] == f'={version}', f'dependencies version mismatch: {component_yml}'
 
 
 def main():
diff --git a/tools/pre_bump_hook.sh b/tools/pre_bump_hook.sh
@@ -0,0 +1,22 @@
+#!/bin/bash
+# Document https://commitizen-tools.github.io/commitizen/
+# eg usage: `cz bump --files-only --increment=PATCH`
+set -e
+
+test -n "$CZ_PRE_CURRENT_VERSION" || (echo "CZ_PRE_CURRENT_VERSION must be set!"; exit 1)
+test -n "$CZ_PRE_NEW_VERSION" || (echo "CZ_PRE_NEW_VERSION must be set!"; exit 1)
+
+# Update Changelog files
+if [ "${CZ_PRE_INCREMENT:-PATCH}" == "PATCH" ]; then
+    # For features or breaking changes, do not add new version to changelog
+    for file in "iperf/CHANGELOG.md" "iperf-cmd/CHANGELOG.md";
+    do
+        # The CURRENT_VERSION line was replaced to NEW_VERSION by commitizen
+        # Insert CURRENT_VERSION line to the changelog file
+        CHANGELOG_STR=$(sed -n '3p' ${file})
+        CHANGELOG_STR=${CHANGELOG_STR//$CZ_PRE_NEW_VERSION/$CZ_PRE_CURRENT_VERSION}
+        sed -i "3 a $CHANGELOG_STR" ${file}
+        sed -i "3 a
+        " ${file}
+    done
+fi
diff --git a/tools/requirements.txt b/tools/requirements.txt
@@ -0,0 +1 @@
+pyYAML
