Merge branch 'ci/improve_github_workflows' into 'master'

ci: improve github workflows and adapt Espressif commitizen plugin

See merge request espressif/esp-serial-flasher!138

Author: dobairoland

.cz.toml

@@ -1,24 +1,12 @@
 [tool.commitizen]
+name = "czespressif"
 version = "1.7.0"
 update_changelog_on_bump = true
-version_scheme = "semver"
 tag_format = "v$version"
 changelog_merge_prerelease = true
 annotated_tag = true
+changelog_start_rev = "v1.0.0"
 bump_message = "change: Update version to $new_version"
 version_files = [
     "idf_component.yml:version"
 ]
-change_type_order = [
-    "BREAKING CHANGE",
-    "New Features",
-    "Bug Fixes",
-    "Code Refactoring",
-    "Performance Improvements"
-]
-
-[tool.commitizen.change_type_map]
-feat = "New Features"
-fix = "Bug Fixes"
-refactor = "Code Refactoring"
-perf = "Performance Improvements"

.github/workflows/dangerjs.yml

@@ -0,0 +1,22 @@
+name: DangerJS Check
+on:
+  pull_request_target:
+    types: [opened, edited, reopened, synchronize]
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  pull-request-style-linter:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out PR head
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+
+    - name: DangerJS pull request linter
+      uses: espressif/github-actions/danger_pr_review@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/new_release.yml

@@ -3,24 +3,25 @@ name: Create a new release from a tag
 on:
   push:
     tags:
-      - "v*.*.*"
-
-permissions:
-  contents: write
+      - v*
 
 jobs:
-  build:
+  create_release:
+    name: Create GitHub release
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - name: Get version
         id: get_version
         run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+        shell: bash
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Get Python packages
-        run: pip install Commitizen
+      - name: Install dependencies
+        run: pip install commitizen czespressif>=1.3.1
       - name: Generate changelog
         run: |
           cz changelog ${{ steps.get_version.outputs.VERSION }} --file-name changelog_body.md
@@ -33,3 +34,4 @@ jobs:
           body_path: changelog_body.md
           name: Version ${{ steps.get_version.outputs.VERSION }}
           draft: true
+          prerelease: false

.github/workflows/pre_commit.yml

@@ -1,23 +1,40 @@
-name: Pre-commit checks
+name: Check pre-commit rules
 
-on: pull_request
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
 
 jobs:
-  pre_commit:
+  pre_commit_check:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
+        uses: actions/checkout@v4
+      - name: Fetch head and base refs
+        # This is necessary for pre-commit to check the changes in the PR branch
+        run: |
+          git fetch origin ${{ github.base_ref }}:base_ref
+          git fetch origin pull/${{ github.event.pull_request.number }}/head:pr_ref
+      - name: Set up Python environment
+        uses: actions/setup-python@master
         with:
-          python-version: '3.11'
-
-      - name: Set up pre-commit
-        run: pip install pre-commit
-
-      - name: Run pre-commit
-        run: pre-commit run --show-diff-on-failure --from-ref origin/master --to-ref HEAD
+          python-version: v3.11
+      - name: Install python packages
+        run: |
+          pip install pre-commit
+          pre-commit install-hooks
+      - name: Run pre-commit and check for any changes
+        run: |
+          echo "Commits being checked:"
+          git log --oneline --no-decorate base_ref..pr_ref
+          echo ""
+          if ! pre-commit run --from-ref base_ref --to-ref pr_ref --show-diff-on-failure ; then
+            echo ""
+            echo "::notice::It looks like the commits in this PR have been made without having pre-commit hooks installed."
+            echo "::notice::Please see https://github.com/espressif/esp-serial-flasher?tab=readme-ov-file#contributing for instructions."
+            echo ""
+            exit 1
+          fi