Merge branch 'bump/new_patch_version' into 'main'

ydhub · ydhub · commit 48491004175c · 2024-05-23T13:56:01.000+08:00
Bump new version 0.1.2

See merge request qa/idf-components/iperf-cmd!8
diff --git a/.cz.toml b/.cz.toml
@@ -1,18 +1,16 @@
 [tool.commitizen]
-version = "0.1.1"
+version = "0.1.2"
 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"
+bump_message = "ci(bump): bump 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
@@ -1,9 +1,8 @@
 name: Publish iperf/iperf-cmd to IDF Component Registry
 
 on:
-  push:
-    tags:
-      - v*
+  release:
+    types: [created]
 
 jobs:
   upload_components:
@@ -15,14 +14,14 @@ jobs:
       - name: check components version same with tag
         run: |
           pip install -r tools/requirements.txt
-          python tools/check_version.py --version ${{ github.ref_name }}
+          python tools/check_version.py --version ${{ github.event.release.tag_name }}
 
       - name: Upload iperf to IDF Component Registry
         uses: espressif/upload-components-ci-action@v1
         with:
           name: "iperf"
           directories: "iperf"
-          version: ${{ github.ref_name }}
+          version: ${{ github.event.release.tag_name }}
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
 
@@ -31,6 +30,6 @@ jobs:
         with:
           name: "iperf-cmd"
           directories: "iperf-cmd"
-          version: ${{ github.ref_name }}
+          version: ${{ github.event.release.tag_name }}
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -83,37 +83,3 @@ 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/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -39,7 +39,19 @@ Your PR may not be published until a new version of this component is released.
 
 When releasing a new component version we have to:
 
-* Create the version tag in this repository
-* Publish the component to component registry
-* Update the version number to next dev version
-* Update the changelog
+- Pass build/test with current (latest) version commit.
+- Bump a new version using `cz bump`:
+
+  ```bash
+  git branch -D bump/new_version || true
+  git checkout -b bump/new_version
+  # bump new version: https://commitizen-tools.github.io/commitizen/commands/bump/
+  cz bump <new_version>
+  # Or
+  cz bump --increment=PATCH
+  ```
+
+  - Change logs are automatically generated and updated.
+- Merge the new version branch into the main branch.
+- Create a new version tag in this repository.
+- Create a new github release and publish the component to component registry.
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.1.1
+    version: =0.1.2
     override_path: ../../../iperf
   espressif/iperf-cmd:
-    version: =0.1.1
+    version: =0.1.2
     override_path: ../../../iperf-cmd
diff --git a/iperf-cmd/CHANGELOG.md b/iperf-cmd/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [v0.1.2](https://github.com/espressif/iperf-cmd/commit//v0.1.2)
+
+### Bug Fixes
+
+- fix build with ipv6 only ([caea9730](https://github.com/espressif/iperf-cmd/commit/caea9730))
+
 ## [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
@@ -32,6 +32,6 @@ This repository contains `iperf` command based esp-idf console.
   ```yaml
   dependencies:
     espressif/iperf_cmd:
-      version: "^0.1.1"
+      version: "^0.1.2"
   ```
 - 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,4 +1,4 @@
-version: 0.1.1
+version: 0.1.2
 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
@@ -8,7 +8,7 @@ license: Apache-2.0
 dependencies:
   idf: '>=4.3'
   espressif/iperf:
-    version: =0.1.1
+    version: =0.1.2
 examples:
   - path: ../apps/iperf/
 files:
diff --git a/iperf/CHANGELOG.md b/iperf/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## [v0.1.2](https://github.com/espressif/iperf-cmd/commit//v0.1.2)
+
+### Bug Fixes
+
+- fix build with ipv6 only ([caea9730](https://github.com/espressif/iperf-cmd/commit/caea9730))
+- No debug if non-fattal errorno ENOBUFS received ([55cce9dc](https://github.com/espressif/iperf-cmd/commit/55cce9dc))
+
 ## [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.1.1"
+      version: "^0.1.2"
   ```
 - 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,4 +1,4 @@
-version: 0.1.1
+version: 0.1.2
 description: Iperf Core Engine
 url: https://github.com/espressif/iperf-cmd/tree/master/iperf
 repository: https://github.com/espressif/iperf-cmd.git
diff --git a/tools/changelog.py b/tools/changelog.py
@@ -0,0 +1,89 @@
+#!/usr/bin/env python
+# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+'''
+Update CHANGELOG file
+'''
+import os
+import pathlib
+import re
+import subprocess
+
+
+COMMIT_BASE_URL = 'https://github.com/espressif/iperf-cmd/commit/'
+PROJECT_ROOT = pathlib.Path(__file__).resolve().parents[1]
+CZ_OLD_TAG = os.environ['CZ_PRE_CURRENT_TAG_VERSION']
+CZ_NEW_TAG = os.environ['CZ_PRE_NEW_TAG_VERSION']
+
+CHANGELOG_SECTIONS = {
+    'feat': 'Features',
+    'fix': 'Bug Fixes',
+    'breaking': 'Breaking Changes',
+    'BREAKING CHANGE': 'Breaking Changes',
+    'update': 'Updates',
+    'change': 'Updates',
+    'remove': 'Updates',
+    'refactor': 'Updates',
+    'revert': 'Updates',
+}
+CHANGELOG_TITLES = ['Features', 'Bug Fixes', 'Updates', 'Breaking Changes']
+assert all((v in CHANGELOG_TITLES for v in CHANGELOG_SECTIONS.values()))
+CHANGELOG_PATTERN = re.compile(rf'({"|".join(CHANGELOG_SECTIONS.keys())})(\([^\)]+\))?:\s*([^\n]+)')
+COMMIT_PATTERN = re.compile(r'^[0-9a-f]{8}')
+
+
+def check_repo():
+    '''Check current ref tag in repository
+    '''
+    subprocess.check_call(
+        ['git', 'fetch', '--prune', '--prune-tags'],
+        cwd=PROJECT_ROOT,
+        )
+
+    # Check old_ref in repository
+    ref_tags = subprocess.check_output(
+        ['git', 'show-ref', '--tags'],
+        cwd=PROJECT_ROOT,
+    ).decode()
+    assert CZ_OLD_TAG in ref_tags
+
+
+def update_changelog():
+    """Update Changelog files in iperf/iperf-cmd from git history
+    """
+    # Update ChangeLog
+    for component in ['iperf', 'iperf-cmd']:
+        git_logs = subprocess.check_output(
+            ['git', 'log', f'{CZ_OLD_TAG}..HEAD', f'{component}'],
+            cwd=PROJECT_ROOT,
+        ).decode()
+
+        changelogs = {k: [] for k in CHANGELOG_TITLES[::-1]}
+        # Get possible changelogs from title and notes.
+        for commit_log in git_logs.split('commit ')[1:]:
+            commit = COMMIT_PATTERN.match(commit_log).group(0)
+            for match in CHANGELOG_PATTERN.finditer(commit_log):
+                if match.group(2):
+                    _changelog = f'- {match.group(2)}: {match.group(3)} ([{commit}]({COMMIT_BASE_URL}{commit}))'
+                else:
+                    _changelog = f'- {match.group(3)} ([{commit}]({COMMIT_BASE_URL}{commit}))'
+                changelogs[CHANGELOG_SECTIONS[match.group(1)]].append(_changelog)
+
+        # Update changelog file
+        with open(str(PROJECT_ROOT / component / 'CHANGELOG.md'), encoding='utf-8') as fr:
+            changelog_data = fr.readlines()
+        changed = False
+        for key, values in changelogs.items():
+            if not values:
+                continue
+            changelog_data.insert(2, f'### {key}\n\n' + '\n'.join(values) + '\n\n')
+            changed = True
+        if changed:
+            changelog_data.insert(2, f'## [{CZ_NEW_TAG}]({COMMIT_BASE_URL}/{CZ_NEW_TAG})\n\n')
+        with open(str(PROJECT_ROOT / component / 'CHANGELOG.md'), 'w', encoding='utf-8') as fw:
+            fw.write(''.join(changelog_data))
+
+
+if __name__ == '__main__':
+    check_repo()
+    update_changelog()
diff --git a/tools/pre_bump_hook.sh b/tools/pre_bump_hook.sh
@@ -1,22 +1,5 @@
-#!/bin/bash
-# Document https://commitizen-tools.github.io/commitizen/
-# eg usage: `cz bump --files-only --increment=PATCH`
+#!/usr/bin/env bash
 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
+# Update changelog
+python tools/changelog.py
